Skip to content

Kamand-Bioengineering-Group/mirage

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Mirage

A python package for creating simulation frameworks
Explore the docs »

View Demo · 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

This project is an python package that allows the creation of arbitrary simulation frameworks using an entity-process-engine based protocol. In this protocol, entities are mere data, and processes are designed to modify these entities according to the simulation requirements. The engine orchestrates everything, ensuring a smooth and efficient simulation process.

⚠️🧪 Epidemic 2.0 is live 🔥

Mirage-Epidemic-Screenshot

Mirage-Epidemic-Screenshot

Mirage-Epidemic-Screenshot

(back to top)

Built With

  • Pydantic
  • FastAPI
  • TensorBoard

(back to top)

Getting Started

Installation

  1. Clone the repo
    git clone https://github.com/Kamand-Bioengineering-Group/mirage.git
  2. pip
    pip install git+https://github.com/Kamand-Bioengineering-Group/mirage.git

(back to top)

Usage

For more examples, please refer to the Documentation

(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!

  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 main feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

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

(back to top)

Contact

Utham Kumar Mahesh
Email - [email protected]

Aditya Prakash
Twitter - @adityaprakash_t
Email - [email protected]

Project Link: https://github.com/Kamand-Bioengineering-Group/mirage.git

(back to top)

Acknowledgments

...

(back to top)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published