Skip to content

pone-software/ananke

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Ananke

A common place for P-ONE data structures.
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

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.

(back to top)

Built With

  • Python
  • PyTorch

(back to top)

Getting Started

This section tells you how to set up the package and be able to run with it.

Prerequisites

This package is built and updated using Poetry. Please install it and make yourself familiar if you never heard of it.

Installation

To install the virtual environment of the package call the following console command

foo@bar:ananke/$ poetry install

(back to top)

Usage

To 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 shell

To open a virtual environment.

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

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!

How to branch

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Janik Prottung - @janikprottung - [email protected]

Project Link: https://github.com/pone-software/ananke

(back to top)

Acknowledgments

(back to top)