Skip to content

RolandoAndrade/general-simulation-framework

Repository files navigation

General Simulation Framework

made-with-python made-with-sphinx-doc Open In Collab PyPi version GitHub license


Logo

General Simulation Framework

Framework for general purpose simulations
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact

About The Project

GSF is a framework for the implementation of simulation tools which offers the possibility of using and extending the same components to generate a wide variety of simulation projects. Its use makes it possible to dispense with the knowledge of several simulation processes, save programming time and maintain a standard structure in the developed solutions.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  • Python >= 3.9

Installation

Download and install by pip:

pip install general-simulation-framework

Usage

You can run the examples in Colaboratory.

For more information, please refer to the Documentation

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.

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

License

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

Contact

RolandoAndrade - GitHub

Project Link: General Simulation Framework