Skip to content

update the documentation #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
martin-rdz wants to merge 1 commit into
base: main
Choose a base branch
from
Open

update the documentation #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

```
# setup a virtual environment (either conda or venv)
git clone https://github.com/ulysses78/PicassoPy.git
git clone https://github.com/PollyNET/PicassoPy.git

cd PicassoPy
python -m pip install -e .
Expand All @@ -25,4 +25,5 @@ python3 tests\picassopy_testing.py --picasso_config_file "pollynet_processing_ch

### History

### License
### License
GNU GPL (see LICENSE)
57 changes: 29 additions & 28 deletions docs/source/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,29 @@
## PollynetProcessingChain python version

[Documentation](https://pollynet.github.io/PicassoPy-doc/html/index.html)

### Installation

```
# setup a virtual environment (either conda or venv)
git clone https://github.com/ulysses78/PicassoPy.git

cd PicassoPy
python -m pip install -e .
```


### Usage

```
python3 tests\picassopy_testing.py --picasso_config_file "pollynet_processing_chain_config.json" \
--date 20240308 --device pollyxt_cpv \
--level0_file_to_process "2024_03_08_Fri_CPV_00_00_01.nc"
```

### Contribute

### History

### License
## PollynetProcessingChain python version

[Documentation](https://pollynet.github.io/PicassoPy-doc/html/index.html)

### Installation

```
# setup a virtual environment (either conda or venv)
git clone https://github.com/PollyNET/PicassoPy.git

cd PicassoPy
python -m pip install -e .
```


### Usage

```
python3 tests\picassopy_testing.py --picasso_config_file "pollynet_processing_chain_config.json" \
--date 20240308 --device pollyxt_cpv \
--level0_file_to_process "2024_03_08_Fri_CPV_00_00_01.nc"
```

### Contribute

### History

### License
GNU GPL (see LICENSE)
2 changes: 2 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ version = "0.1.1"
authors = [
{ name="Andi Klamt", email="klamt@tropos.de" },
{ name="Martin Radenz", email="radenz@tropos.de" },
{ name="Håvard Buholdt", email="buholdt@tropos.de" },
]
description='Data cube for handling atmospheric observations of profiling remote sensing instruments.'
requires-python = ">=3.8"
Expand All @@ -32,6 +33,7 @@ dependencies = [
"pandas",
"openpyxl", # might be an optional dependency
"GitPython",
"matplotlib",
]

[tool.setuptools.packages]
Expand Down