CFD simulation software for Martlet 3
This software is primarily written in Python and may be installed via the
standard pip
utility:
$ pip install git+https://github.com/cuspaceflight/firefish.git
For developers, pip
can be used to create a "development" install which uses
symlink magic to allow changes in files to be reflected without re-installing:
$ git clone git@github.com:cuspaceflight/firefish.git
$ cd firefish
$ pip install -e .
The tox automation tool is used to automate the process of running the test suite under both Python 2.7 and whichever version of Python 3 is installed on the system. To run the test suite:
$ tox
Documentation is generated by the Sphinx tool. It lives in the doc directory and can be compiled via:
$ pip install -r doc/requirements.txt
$ sphinx-build doc build/html
The file build/html/index.html
contains the index page for the
documentation.