simple-space-simulator

This is the main repository for the Simple Space Simulator (or S-Cubed) python package.

To get started run conda env create -f env.yml. After creating the environment run conda activate simple_space_simulator and run python3 setup.py install.

Documentation

This package follows the numpydoc docstring guidelines.

Linting

This project uses flake8 (with max line length set to 120) which is installed in the conda environment. To check for code issues run flake8 --max-line-length 120. To automatically reformat code run autopep8 --in-place --recursive --max-line-length 120 . which is also installed automatically into you conda environment. The build will not succeed unless code has no flake8 errors.