diff --git a/README.md b/README.md index cb0d9c167916e55131c692da5a8051bd6c429c16..4724642995fb851d04351e95af57c835614bc64e 100644 --- a/README.md +++ b/README.md @@ -1,74 +1,23 @@ # moist_thermodynamics -a repository containing functions and constants relevant to the treatment of moist atmospheric processes - -## Getting started - -To make it easy for you to get started with GitLab, here's a list of recommended next steps. - -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! - -## Add your files - -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: - -``` -cd existing_repo -git remote add origin https://gitlab.dkrz.de/m219063/moist_thermodynamics.git -git branch -M main -git push -uf origin main -``` - -## Integrate with your tools - -- [ ] [Set up project integrations](https://gitlab.dkrz.de/m219063/aes_thermo/-/settings/integrations) - -## Collaborate with your team - -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) - -## Test and Deploy - -Use the built-in continuous integration in GitLab. - -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) - -*** - -# aes_thermo README - - ## Description -This repository contains constants and functions used for the analysis of moist thermodynamic processes. An effort is made to be as accurate as possible given -the assumption of a Rankine fluid, i.e., zero condensate volume, perfect mixtures of perfect gases, perfect liquids and constancy of specific heats. In some -cases even more exact treatments will be desired, for instance the more accurate specifications of the saturation vapor pressure are not consistent with the -assumptions of a Rankine fluid, but these will generally be the exception. - -## Installation +This repository contains constants and functions used for the analysis of moist thermodynamic processes. An effort is made to be as accurate as possible given the assumption of a Rankine-Kirchoff fluid, i.e., zero condensate volume, perfect mixtures of perfect gases, perfect liquids and constancy of specific heats. +In some cases even more exact treatments will be desired, for instance the more accurate specifications of the saturation vapor pressure are not consistent with the assumptions of a Rankine-Kirchoff fluid, but these will generally be the exception. More accurate formulations are available, for instansce, using the IAPWS package or its deriviatives. ## Usage -Jupyter notebooks provide illustrative use cases +Jupyter notebooks provide illustrative use cases and further informatino pursuant to choices made in structuring the code, and the functionality it enables. ## Support Contact bjorn.stevens@mpimet.mpg.de for support - ## Contributing -Code contributions are welcome. +Code contributions are welcome. Please suggest changes on a branch and make a merge request. ## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. +The code was written by Bjorn Stevens (MPI-M Hamburg). -## License -The code in this directory is all licensed as BSD-3C as stipulated by the LICENSE file in the root directory +Lukas Kluft and Tobias Kölling provided input and guidance in setting up the repository and on matters related to python. Jiawei Bao, Geet George and Hauke Schulz provided feedback on the thermodynamic analysis. +## License +The code in this directory is all licensed as BSD-3C as stipulated by the LICENSE file in the root directory \ No newline at end of file