tpg-256a-pressure-monitor 0.1.0

Readout software for the Pfeiffer TPG-256A Pressure Controller

README

TPG.256A Pressure Monitor

The TPG-256A Pressure Monitor is a readout and logging application for the Pfeiffer TPG-256A Pressure Controller.

Dependencies

The package tpg-256a-pressure-monitor has the following pre-requisites:

• Python 3.6 and pip 10.0 are the minimum required versions to build and install tpg-256a-pressure-monitor and its dependencies. It is recommended to install and run tpg-256a-pressure-monitor (and any other package, for that matter) under a virtual environment.

Getting Started

These instructions will install the package tpg-256a-pressure-monitor and let you run from the command line terminal. It is assumed that you have successfully installed the prerequisites and are running inside a virtual environment.

1. Clone the repository into the directory $DIR:

   git clone [e-mail]:exotic-matter/cw-beam/tpg-256a-pressure-monitor $DIR
   cd $DIR
   

2. Install the package and its dependencies

   python -m pip install .
   

3. If you want to build the documentation

   cd $PATH_TO_SOURCE
   python -m pip install .[docs]
   cd docs
   make clean
   make html
   

Usage

To use a the tpg-256a-pressure-monitor package, TODO

Authors

• Carlos Vigo - Initial work - GitLab

Contributing

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

Versioning

We use Git for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the GNU GPLv3 License

Built With

• PyCharm Community Edition - The IDE used
• Sphinx - Documentation

Acknowledgments

• Nobody so far