https://github.com/openfluid/pyopenfluid

Python package for OpenFLUID
https://github.com/openfluid/pyopenfluid

python

Last synced: 11 months ago
JSON representation

Python package for OpenFLUID

• Host: GitHub
• URL: https://github.com/openfluid/pyopenfluid
• Owner: OpenFLUID
• License: other
• Created: 2018-07-26T12:16:52.000Z (over 7 years ago)
• Default Branch: develop
• Last Pushed: 2024-12-11T17:17:54.000Z (about 1 year ago)
• Last Synced: 2025-01-01T00:45:34.378Z (about 1 year ago)
• Topics: python
• Language: C++
• Homepage:
• Size: 14.6 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
Overview

========

This package allows to load, parameterize, run and analyze OpenFLUID simulations from Python.

It is compatible with Python 3 and requires that the `OpenFLUID platform `_ is already installed

*Currently, this package is in early development stage and has only be tested on Linux system*

Installation

============

from PyPI

---------

*TODO*

from sources

------------

Classic installation (main usage)

.. code-block:: shell

    pip3 install .

Installation linked to the current sources (usually for development purposes)

.. code-block:: shell

     pip3 install -e .

Development

===========

Run the following commands from the root of the sources tree.

Check

-----

.. code-block:: shell

   python3 setup.py check

Build

-----

.. code-block:: shell

   python3 setup.py build

Test

----

.. code-block:: shell

   python3 setup.py build test

Packaging

---------

.. code-block:: shell

   python3 setup.py sdist bdist

Misc resources

--------------

* https://stackoverflow.com/questions/42585210/extending-setuptools-extension-to-use-cmake-in-setup-py

* http://intermediate-and-advanced-software-carpentry.readthedocs.io/en/latest/c++-wrapping.html

* https://github.com/avast-tl/yaramod/blob/master/setup.py

* http://www.benjack.io/2017/06/12/python-cpp-tests.html

* https://github.com/dabeaz/python-cookbook/tree/master/src/15/writing_a_simple_c_extension_module