diff --git a/README.md b/README.md index 94861bf26edd23b34c617c607f07537bc0323a68..7fd5f6b130fcb4b4e02d08902cf7021f230a7508 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,67 @@ +<!-- [](https://zenodo.org/badge/latestdoi/28657065) --> + + +<div id="top"></div> +<br /> +<div align="center"> + <a href="https://github.com/lagoproject/atmosphere"> + <img src="./docs/images/lago-logo.png" alt="Logo" width="140"> + </a> + <h3 align="center">The LAGO Monthly Averaged Atmospheric Profiles Library</h3> + <p align="center"> + To optimize the simulation of the expected background or signals flux at each site, we [developed a method](https://doi.org/10.1139/cjp-2020-0561) to obtain the monthly-averaged local atmospheric profiles, obtained from the instantaneous [Global Data Assimilation System (GDAS)](https://www.ncei.noaa.gov/access/metadata/landing-page/bin/iso?id=gov.noaa.ncdc:C00379) profiles. + <br /> + <br /> + <a href="https://github.com/lagoproject/atmospheres/issues">Request Feature</a> + · + <a href="https://github.com/lagoproject/arti/issues">Report Bug</a> + · + <a href="#Contact">Contact us</a> +</p> +</div> + + ## LAGO sites atmospheric profiles -To optimize the simulation of the expected background or signals flux at each site, we [developed a method](https://doi.org/10.1139/cjp-2020-0561) to obtain the monthly-averaged local atmospheric profiles, obtained from the instantaneous [Global Data Assimilation System (GDAS)](https://www.ncei.noaa.gov/access/metadata/landing-page/bin/iso?id=gov.noaa.ncdc:C00379) profiles. +In this repository we storage the atmospheric profiles for all the LAGO sites described in the [LAGO DMP](https://lagoproject.github.io/DMP/), starting in January 2015. While it is not exclusive, it is mainly intended to be used within the [ARTI](https://github.com/lagoproject/arti) atmospheric radiation background tool suite. + +## Proposed features + +See the [open issues](https://github.com/lagoproject/arti/issues) for a full list of proposed features (and known issues). + +<p align="right">(<a href="#top">back to top</a>)</p> + +<!-- CONTRIBUTING --> +## Contributing + +Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. + +If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". +Don't forget to give the project a star! Thanks again! + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + +<p align="right">(<a href="#top">back to top</a>)</p> + +## Acknowledgement + +This package includes a slightly modified version of the [gdastool](https://doi.org/10.1016/j.astropartphys.2020.102470), a publicly available code to obtain parameterized GDAS atmospheric profiles for user-specified time and location. This code is included in the [CORSIKA](https://www.iap.kit.edu/corsika/) distribution since version CORSIKA v7.6300. + +<!-- LICENSE --> +## License + +ARTI is distributed under the [BSD-3 License](https://opensource.org/licenses/BSD-3-Clause). See the [LICENCE](LICENSE) for more information. + +<p align="right">(<a href="#top">back to top</a>)</p> + +<!-- CONTACT --> +## Contact -In this repository we storage the atmospheric profiles for all the LAGO sites described in the [LAGO DMP](https://lagoproject.github.io/DMP/), starting in January 2015. While it is not exclusive, it is mainly intended to be used within the [ARTI](https://github.com/lagoproject/arti) atmospheric radiation background toolsuite. Atmosheric instantaneous profiles need large storage and were not included in this public repository, but are available upon request. Please don't hesitate to [contact us](https://lagoproject.net/contact.html) for further requests or comments. +This library is mantained by H. Asorey (@asoreyh) for the LAGO simulation group. Atmosheric instantaneous profiles need large storage and were not included in this public repository, but are available upon request. Please don't hesitate to [contact us](https://lagoproject.net/contact.html) for further requests or comments. -- @asoreyh for the @lagoproject diff --git a/docs/images/flux-chacaltaya.png b/docs/images/flux-chacaltaya.png new file mode 100644 index 0000000000000000000000000000000000000000..a863eda38d1eb77bced0eeaa08d7a8e1e044a30f Binary files /dev/null and b/docs/images/flux-chacaltaya.png differ diff --git a/docs/images/geomagnetic.png b/docs/images/geomagnetic.png new file mode 100644 index 0000000000000000000000000000000000000000..01e3617f8300d6597cc2ca64067ff7f231a356d0 Binary files /dev/null and b/docs/images/geomagnetic.png differ diff --git a/docs/images/lago-logo.png b/docs/images/lago-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..8cd6151d6410c660b4515e6e28c23248a5da35b9 Binary files /dev/null and b/docs/images/lago-logo.png differ diff --git a/docs/images/wcd-muon.png b/docs/images/wcd-muon.png new file mode 100644 index 0000000000000000000000000000000000000000..86ed9d8357e7ff96f05aadb12555c4a632466eb4 Binary files /dev/null and b/docs/images/wcd-muon.png differ