Skip to content

Latest commit

 

History

History
53 lines (30 loc) · 1.52 KB

README.md

File metadata and controls

53 lines (30 loc) · 1.52 KB

Fiatlux logo

Fiatlux

Fiatlux is a project that aims to offer a versatile environment for multiple optical simulation. The project details and specific goals can be found in the PROJECT_GOALS.md file.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them:

Installing

A step by step series of examples that tell you how to get a development environment running:

  1. Clone the repository:

git clone https://github.com/bidou2002/fiatlux.git

  1. Install the dependencies:

pip install -r requirements.txt

  1. Install the package:

pip install -e fiatlux

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

  • Pierre Janin-Potiron - Initial work - bidou2002
  • Yoann Brûlé - Initial work
  • Olivier Fauvarque - Initial work

See also the list of contributors who participated in this project.

Acknowledgments

  • Hat tip to anyone whose code was used
  • Inspiration
  • etc