Metadata-Version: 2.1
Name: py4cats
Version: 4.0.0
Summary: A collection of Python scripts for (molecular) line-by-line absorption (cross sections, optical depths, ...) and atmospheric radiative transfer
Home-page: https://atmos.eoc.dlr.de/tools/Py4CAtS/index.html
License: GNU General Public License
Keywords: physics,spectroscopy,atmosphere,line-by-line,radiative,transfer,molecular,absorption
Author: Franz Schreier
Author-email: franz.schreier@dlr.de>, Philipp Hochstaffl <philipp.hochstaffl@dlr.de
Requires-Python: >=3.10,<3.13
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Scientists :: Students :: Developers
Classifier: License :: GNU General Public License
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Computational Physics :: Atmospheric Spectroscopy :: Libraries :: Python Modules
Requires-Dist: ipython (>=8.20.0,<9.0.0)
Requires-Dist: matplotlib (>=3.7.2,<4.0.0)
Requires-Dist: numpy (>=1.24.3,<2.0.0)
Requires-Dist: pyqt5-tools (>=5.15.9.3.3,<6.0.0.0.0)
Requires-Dist: qtconsole (>=5.3,<6.0)
Requires-Dist: scipy (>=1.11.1,<2.0.0)
Project-URL: issues, https://gitlab.dlr.de/MF-ATP/py4cats/-/issues
Description-Content-Type: text/markdown

# Py4CAtS --- Python for Computational ATmospheric Spectroscopy

### Installation: Getting started with Py4CAtS

Download the wheel file and execute the following command:
```
pip install py4cats-3.1.0-py3-none-any.whl
```

The command installs Py4CAtS in your current Python environment.

Prerequisites: Python (>=3.10) and numpy (sometimes scipy and matplotlib for plotting) but the pip installer should take care of dependencies. 

### Usage
Py4CAtS can be used in two ways, from inside the (I)Python interpreter or Jupyter Qt Console or Notebook (see the demo!NEW! or the poster for the ASA-HITRAN 2016 congress) or from the Unix/Linux (or Windows/Mac?) console/terminal.

In an (I)Python shell the package becomes available for the Python interpreter after one of the following import statements:
```
import py4cats
from py4cats import *
```

If you also want to use Py4CAtS from the console/terminal you need to create a `./bin` directory beside the `./lbl`, `./art`, `./var` directories.
Next execute the following (t)csh command in the current directory to create links for all executable scripts/modules:

```
foreach file ( `grep -l '/usr/bin/env python' {art,var,lbl}/*.py` )
   if ( -x $file ) ln -s ../$file bin/$file:r:t
end 
```

Data and Documentation
To play around, download the tarball which contains data files and the documentation.
Unpack it with the command 
```
tar xfvz data_and_doc.tgz 
```
at some convenient place.

And you need some line data (HITRAN and/or GEISA). For the beginning, here is a thermal infrared excerpt of Hitran 86.

For a detailed review of line-by-line modeling for infrared radiative transfer see the manual py4cats.pdf in the doc directory.
Sections 5 and 6 describe Py4CAtS' usage from the Unix/Linux shell and the (i)python shell, respectively. 
