Skip to content
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.

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

Add pyaeroval CLI example in documentation #670

Closed
AugustinMortier opened this issue Jun 8, 2022 · 5 comments
Closed

Add pyaeroval CLI example in documentation #670

AugustinMortier opened this issue Jun 8, 2022 · 5 comments
Assignees
Labels
documentation 📖 Everything related to code documentation, tutorials and examples

Comments

@AugustinMortier
Copy link
Member

In the documentation, there are some exmaples of pyaeroval configuration files. Would be great to add the command line to run this experiment.

@jgriesfeller
Copy link
Member

just put python in front and it runs...

@AugustinMortier
Copy link
Member Author

Then it should be easy to solve ;)

@AugustinMortier
Copy link
Member Author

For info, I'm writing a page describing how external users could contribute to AeroVal. It would be nice to have clear examples that could be just copy paste.

@lewisblake
Copy link
Member

I tend to agree with @jgriesfeller on this. I'm not sure this is the most appropriate addition to the CLI bu certainly it would be easy to include something like python config_example.py in some documentation. It also demonstrates how all other config files users might make will be executed

@AugustinMortier
Copy link
Member Author

I think that it does not cost a lot to mention that a 'configuration could be run as following: ....'
And that the code blocks in this page are actually .py files. It might not be as obvious as you think for external users.

The general pyaerocom tutorials are quite well detailed: anybody with an access to the data can easily read Aeronet data and plot things. When it's about processing AeroVal files, I think the recipe is not that clear yet.

@avaldebe avaldebe added the documentation 📖 Everything related to code documentation, tutorials and examples label Jun 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📖 Everything related to code documentation, tutorials and examples
Projects
None yet
Development

No branches or pull requests

5 participants