Skip to content

Latest commit

 

History

History
88 lines (53 loc) · 1.92 KB

README.rst

File metadata and controls

88 lines (53 loc) · 1.92 KB

streamlines: streamlines

License MIT

Computation of Streamlines ...

Main features

  • feature
  • feature
  • more features

streamlines runs on Python x.x and x.x.

Documentation

Requirements

Installation

Contributing

Make sure you setup your local development environment correctly:

  • Clone the streamlines repository.
  • Install development dependencies and make the project accessible from Rhino:
pip install -r requirements-dev.txt
invoke add-to-rhino

You're ready to start working!

During development, use tasks on the command line to ease recurring operations:

  • invoke clean: Clean all generated artifacts.
  • invoke check: Run various code and documentation style checks.
  • invoke docs: Generate documentation.
  • invoke test: Run all tests and checks in one swift command.
  • invoke add-to-rhino: Make the project accessible from Rhino.
  • invoke: Show available tasks.

For more details, check the Contributor's Guide.

Releasing this project

Credits

This package was created by Rafael Pastrana <rafaepastrana@gmail.com> @arpastrana at Gramazio Kohler Research @gramaziokohler