Contribute to Ergo core¶
To get started:
git clone https://github.com/oughtinc/ergo.git
Ergo uses poetry to manage its dependencies and environments.
Follow these directions to install poetry if you don’t already have it.
Troubleshooting: If you get
Could not find a version that satisfies the requirement jaxlib ... after using poetry to install, this is probably because your virtual environment has old version of pip due to how poetry choses pip versions.
poetry run pip install -U pip
Before submitting a PR¶
poetry installto make sure you have the latest dependencies
Format code using
make format(black, isort)
Run linting using
make lint(flake8, mypy, black check)
Run tests using
To run the tests in
test_metaculus.py, you’ll need our secret .env file. If you don’t have it, you can ask us for it, or rely on Travis CI to run those tests for you.
Generate docs using
make docs, load
docs/build/html/index.htmland review the generated docs
Or run all of the above using
numpy as follows:
import jax.numpy as np import numpy as onp