# oopt-raman

**Repository Path**: CarlZhang-HUST/oopt-raman

## Basic Information

- **Project Name**: oopt-raman
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-10-22
- **Last Updated**: 2020-12-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OOPT-Raman

oopt-raman is a python library for evaluating the stimulated Raman scattering in optical communication systems.
The Raman solver is implemented solving the set of pump and probe ordirary differential equations.

### Installation

`oopt-raman` can be installed from the repository.
```sh
$ git clone https://github.com/Telecominfraproject/oopt-raman.git
$ cd oopt-raman
$ git checkout develop
$ python3 setup.py install
```

### Instructions on how run the example

The example needs `matplotlib`. To install it, you can use pip.
```sh
$ pip install matplotlib
```

Then you have to navigate to the example folder.
```sh
$ cd /oopt-raman/examples
```

Launch the example
```sh
$ python3  main_raman_amplifier.py
```