Contribution

Contributions from the community are welcome. Interested collaborators can make contact with Koyo Munechika (Core Developer) from the Source Repository.

Core Team

• Koyo Munechika (Core Developer)

Contributors

• Anyone is welcome!!

For Developers

If you would like to develop this package, please fork the GitHub Repository at first, and follow the installation procedure.

Pixi is required for several development tasks, such as building the documentation and running the tests. Please install it by following the Pixi Installation Guide in advance.

Note

Before you start developing, please ensure that your code remains clean and consistent by installing pre-commit. Running the following command will automatically set up the hooks:

pixi run pre-commit-install

test

To run the tests, you can do so with:

pixi run test

docs

To build the documentation, you can do so with:

pixi run doc-build

The documentation will be built in the docs/build/html directory.

If you want to clean the documentation, you can do so with:

pixi run doc-clean

If you want to host the documentation locally, you can do so with:

pixi run doc-serve

lint/format

To lint the code, you can do so with:

pixi run lint

To format the code, you can do so with:

pixi run format

To run pre-commit hooks for all files, you can do so with:

pixi run pre-commit-run

ipython

To run the IPython shell, you can do so with:

pixi run ipython

The IPython shell will be started with the package installed.

Note

All registered commands can be shown by:

pixi tasks list

Note

If you have any questions or issues, please feel free to open an Issue in the GitHub Repository.