Skip to content

Commit

Permalink
update rst
Browse files Browse the repository at this point in the history
  • Loading branch information
JunjieYU-UoM committed Feb 26, 2024
1 parent 2de225b commit e0ec6b5
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/cesm.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
python API
Python API
===========

.. automodule:: cesm
Expand Down
2 changes: 1 addition & 1 deletion docs/container/1_intro_container.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,5 @@ make -j && make install
```

### [Python for urban climate exploration](5_python_API.md)
We apply some Python codes to help run a case of CLM to explore urban climate.
We apply some Python code to help run a case of CLM to explore urban climate.

2 changes: 1 addition & 1 deletion docs/container/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,5 @@ Running CMLU within CLM (Community Land Model) requires a Linux operation system

Python for urban climate exploration
------------------------------------
We apply some Python codes to help run a case of CLM to explore urban climate.
We apply some Python code to help run a case of CLM to explore urban climate.

2 changes: 1 addition & 1 deletion docs/container/run_container.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ export CSMDATA=/p/scratch/CESMDATAROOT/inputdata
export CASESCRIPT=/p/project/myclm/cime/scripts
```

#### Tips for docker commander
#### Tips for docker commands
- docker ps: check for the running container
- docker stop <container-id>: stop the container
- docker start <container-id>: start the container
Expand Down
12 changes: 4 additions & 8 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,24 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
CLMU APP
CLMU-App
==================================

|docs| |GitHub| |license|

.. |docs| image:: https://readthedocs.org/projects/urbanclimateexplorer/badge/?version=latest
:target: https://urbanclimateexplorer.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
|GitHub| |license|

.. |GitHub| image:: https://img.shields.io/badge/GitHub-clmu--app-brightgreen.svg
:target: https://github.com/envdes/clmu-app

.. |license| image:: https://img.shields.io/badge/License-MIT-blue.svg
:target: https://github.com/envdes/clmu-app/blob/main/LICENSE

Using Python to drive CLMU simulations via container.
CLMU-App: Enabling Operating System Indenpendent Urban Climate Simulations

Author: `Junjie Yu <https://junjieyu-uom.github.io>`_, `Dr. Zhonghua Zheng <https://zhonghuazheng.com>`_, `Yuan Sun <https://github.com/YuanSun-UoM>`_, `Dr. Keith Oleson <https://staff.ucar.edu/users/oleson>`_

.. toctree::
:maxdepth: 2
:caption: CLMU APP container
:caption: CLMU-App container

container/intro.rst
container/install_docker.rst
Expand Down

0 comments on commit e0ec6b5

Please sign in to comment.