Table of Contents
Like the greek god ananke, this repository is all necessities. The Pacific Ocean Neutrino Experimen (P-ONE) is a neutrino detector to be built in the Pacific Ocean. To run that detector, a lot of code is needed and many data structures are repeating. This package manifests a common data structure that serves between packages. Relying on this data structure photons can be propagated, configurations can be stored and triggers can be trained.
This section tells you how to set up the package and be able to run with it.
This package is built and updated using Poetry. Please install it and make yourself familiar if you never heard of it.
To install the virtual environment of the package call the following console command
foo@bar:ananke/$ poetry installTo use it, either call the commands of the Makefile. To list them call make help.
If you want to have a granular check, you can run
foo@bar:ananke/$ poetry shellTo open a virtual environment.
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Janik Prottung - @janikprottung - [email protected]
Project Link: https://github.com/pone-software/ananke