https://github.com/cuspaceflight/firefish

CFD simulation software for Martlet 3
https://github.com/cuspaceflight/firefish

Last synced: about 2 months ago
JSON representation

CFD simulation software for Martlet 3

• Host: GitHub
• URL: https://github.com/cuspaceflight/firefish
• Owner: cuspaceflight
• License: apache-2.0
• Created: 2015-11-12T18:29:18.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-06-21T16:59:39.000Z (over 8 years ago)
• Last Synced: 2024-04-17T03:54:21.078Z (8 months ago)
• Language: Python
• Size: 2.76 MB
• Stars: 5
• Watchers: 21
• Forks: 4
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# firefish

[![Build Status](https://travis-ci.org/cuspaceflight/firefish.svg?branch=master)](https://travis-ci.org/cuspaceflight/firefish)

[![Coverage

Status](https://coveralls.io/repos/cuspaceflight/firefish/badge.svg?branch=master&service=github)](https://coveralls.io/github/cuspaceflight/firefish?branch=master)

[![Documentation

Status](http://readthedocs.org/projects/firefish/badge/?version=latest)](http://firefish.readthedocs.org/en/latest/?badge=latest)

CFD simulation software for Martlet 3

## Installation

This software is primarily written in Python and may be installed via the

standard ``pip`` utility:

```console

$ 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:

```console

$ git clone [email protected]:cuspaceflight/firefish.git

$ cd firefish

$ pip install -e .

```

## Testing

The [tox](https://tox.readthedocs.org/) 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:

```console

$ tox

```

## Documentation

Documentation is generated by the [Sphinx](http://sphinx-doc.org/) tool. It

lives in the [doc](doc/) directory and can be compiled via:

```console

$ pip install -r doc/requirements.txt

$ sphinx-build doc build/html

```

The file ``build/html/index.html`` contains the index page for the

documentation.