Community Guidelines

We encourage the broader community to contribute to pysr3! Please submit a pull request on GitHub if you fixed a bug or developed an extension. If you experience any issues please open a new issue on the Issues page, and we will do our best to help.

As a community, we follow the list of rules below:

  1. We adhere to sklearn’s interfaces and standards

    • Please use sklearn.utils.estimator_checks.check_estimator to ensure that your contributions don’t break this compatibility.

  2. For comments and docstrings, we use numpy dostring standards

  3. For version numbers, we use Semantic Versioning.

  4. We pledge to Contributor Covenant code of conduct.

Developing pysr3

pysr3 does not require any special hardware and can be developed on your personal computer. To start, install pysr3 in the developer mode:

git clone https://github.com/aksholokhov/pysr3.git
cd pysr3
python setup.py develop

Testing pysr3

To test the installation, invoke the tests with pytest:

pytest .