paddle 1.1.11__py3-none-any.whl → 1.1.15__py3-none-any.whl

paddle/__init__.py

@@ -4,4 +4,4 @@ from .find_init_params import find_init_params
 from .evolve_kinetics import evolve_kinetics
 
 __all__ = ["setup_profile", "write_profile", "find_init_params", "evolve_kinetics"]
-__version__ = "1.1.11"
+__version__ = "1.1.15"

paddle-1.1.15.dist-info/METADATA

@@ -0,0 +1,161 @@
+Metadata-Version: 2.4
+Name: paddle
+Version: 1.1.15
+Summary: Python Atmospheric Dynamics: Discovery and Learning about Exoplanets. An open-source, user-friendly python frontend of canoe
+Project-URL: Homepage, https://github.com/elijah-mullens/paddle
+Project-URL: Repository, https://github.com/elijah-mullens/paddle
+Project-URL: Issues, https://github.com/elijah-mullens/paddle/issues
+Author-email: Elijah Mullens <eem85@cornell.edu>, Cheng Li <chengcli@umich.edu>
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.9
+Requires-Dist: kintera>=1.1.5
+Requires-Dist: scipy
+Requires-Dist: snapy>=0.8.1
+Requires-Dist: torch<=2.7.1,>=2.7.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Paddle
+
+Python Atmospheric Dynamics: Discovering and Learning about Exoplanets. An open-source, user-friendly Python version of [canoe](https://github.com/chengcli/canoe).
+
+## Test the package
+
+Testing the package can be done very easily by following the steps below. All we need is to create a python virtual environment, install the package, and run the test script.
+
+1. Create a python virtual environment
+
+   ```bash
+   python -m venv pyenv
+   ```
+
+2. Install paddle package
+
+   ```bash
+   pip install paddle
+   ```
+
+3. Run test
+
+   ```bash
+   cd tests
+   python test_saturn_adiabat.py
+   ```
+
+## Develop with Docker
+
+You may need to install Docker to compose up and install the package inside a container if your device or operating system does not support certain dependencies. Follow the instructions below to install docker and docker-compose plugin.
+
+1. Install docker with compose
+
+   ```bash
+   curl -fsSL https://get.docker.com | sudo sh
+   ```
+
+2. Start docker using the command below or open docker desktop if applicable.
+
+   ```bash
+   sudo systemctl start docker
+   ```
+
+After installing Docker, you can use the Makefile commands below to manage your docker containers from the terminal. By default, the container will mount the current directory to `/paddle` inside the container.
+
+> Mounting a local directory allows you to edit files on your local machine while running and testing the code inside the container; or use the container as a development environment and sync files to your local machine.
+
+If you want to change the mounted directory, you can create a `docker-compose.overrides.yml` file based on the provided `docker-compose.overrides.yml.tmp` template file.
+
+- Create a docker container
+
+  ```bash
+  make up
+  ```
+
+- Start a docker container (only if previously created)
+
+  ```bash
+  make start
+  ```
+
+- Terminate a docker container
+
+  ```bash
+  make down
+  ```
+
+- Build a new docker image (rarely used)
+
+  ```bash
+  make build
+  ```
+
+If you use VSCode, it is recommended to install extensions including [Remote Development](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack), [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) and [Container Tools](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-containers) for a better development experience within a container.
+
+1. Install the extensions mentioned above.
+2. Start the container using `make up` or `make start`.
+3. Open VSCode and click on the "Containers" icon on the left sidebar. Note that if you have too many extensions installed, the icon may be hidden under the "..." menu.
+
+   <img src="docs/_static/readme-extension.png" width="200" style="vertical-align: top;">
+   <img src="docs/_static/readme-attach.png" width="200" style="vertical-align: top;">
+
+4. Right click on the running container named `paddle` with a green triangle icon (indicating it is running), and select "Attach Visual Studio Code" (see above images). This will open a new VSCode window connected to the container.
+5. Open either the default folder `paddle` mounted from your local machine, or any custom workspace folder you have set up inside the `docker-compose.overrides.yml` file. Now you can start developing inside the container as if you were working on your local machine!
+
+   <img src="docs/_static/readme-open-folder.png" width="500" style="vertical-align: top;">
+
+## For Developers
+
+Follow the steps below to set up your development environment.
+
+1. Clone the repository
+
+   ```bash
+   https://github.com/elijah-mullens/paddle
+   ```
+
+2. Cache your github credential. This will prevent you from being prompted for your username and password every time you push changes to github.
+
+   ```bash
+   git config credential.helper 'cache --timeout=86400'
+   ```
+
+3. Create a python virtual environment.
+
+   ```bash
+   python -m venv .pyenv
+   ```
+
+4. Install paddle package
+
+   ```bash
+   # Install the package normally
+   pip install paddle
+
+   # [Alternatively] if you want to install in editable mode
+   pip install -e .
+   ```
+
+5. Install pre-commit hook. This will automatically format your code before each commit to ensure consistent code style.
+
+   ```bash
+   pip install pre-commit
+   pre-commit install
+   ```
+
+## Troubleshooting
+
+1. If you have Docker installed but do not have Docker Compose, remove your current Docker installation, which could be docker or docker.io, and re-install it following the guide provided in the [Develop with Docker](#develop-with-docker) section above.

{paddle-1.1.11.dist-info → paddle-1.1.15.dist-info}/RECORD

@@ -1,4 +1,4 @@
-paddle/__init__.py,sha256=lsjXyx46HR-2ub7DkfpYJrUQQKVSFi6QWqr_kJPFd7g,282
+paddle/__init__.py,sha256=LKTsvbB-zkmi6wCGlc99PijCtLjNyDeP6B0vMOXRJh4,282
 paddle/crm.py,sha256=HwOLAojR5LBcptqjAC9APEJiWpn8GhxPiAmvvIZ4mTM,1986
 paddle/evolve_kinetics.py,sha256=OWt1-SiLTzaWUCIchwRnBHCjbtcgJIIxrlQ5Lk4iN8c,1541
 paddle/find_init_params.py,sha256=dyRmo-LTwVohbPhSH5LV45jL_XeRmNEcuKPvafBklto,2516
@@ -6,8 +6,8 @@ paddle/nc2pt.py,sha256=LXR0fnUTaOA_uaDsLU4YqdAVFyycB6SvRq12xWhHhLA,1136
 paddle/pt2nc.py,sha256=lLviBm6a2O05RvuPQc8DxV5pGr_VEhlSkrKPV1lQ3yU,3913
 paddle/setup_profile.py,sha256=oJpqPnlq2q1rn_l2flwgbdWwbxbhxx4QOYl4ezWmP-o,8803
 paddle/write_profile.py,sha256=HeBtGaFixGv8DnmJWPiQs-30RsdplSObhMA6ky6eVrg,3908
-paddle-1.1.11.dist-info/METADATA,sha256=EnC-UYAntB1Kl_TfwDjbAQA9Fz_vuoCMoXwZtXsJzIM,2687
-paddle-1.1.11.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-paddle-1.1.11.dist-info/entry_points.txt,sha256=pDR96GW6ylBZrbFd-tRGthW8qTuYaSLjrEt1LFIEYto,48
-paddle-1.1.11.dist-info/licenses/LICENSE,sha256=e6NthgKABUnLRqjuETcBGgsOuA-aJANpNoeXMe9RBso,1071
-paddle-1.1.11.dist-info/RECORD,,
+paddle-1.1.15.dist-info/METADATA,sha256=eTNgZHYYqNvDlNY_tJfx1wkmMcuu7YgyZ56iv2v0UzU,6036
+paddle-1.1.15.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+paddle-1.1.15.dist-info/entry_points.txt,sha256=pDR96GW6ylBZrbFd-tRGthW8qTuYaSLjrEt1LFIEYto,48
+paddle-1.1.15.dist-info/licenses/LICENSE,sha256=e6NthgKABUnLRqjuETcBGgsOuA-aJANpNoeXMe9RBso,1071
+paddle-1.1.15.dist-info/RECORD,,

paddle-1.1.11.dist-info/METADATA

@@ -1,110 +0,0 @@
-Metadata-Version: 2.4
-Name: paddle
-Version: 1.1.11
-Summary: Python Atmospheric Dynamics: Discovery and Learning about Exoplanets. An open-source, user-friendly python frontend of canoe
-Project-URL: Homepage, https://github.com/elijah-mullens/paddle
-Project-URL: Repository, https://github.com/elijah-mullens/paddle
-Project-URL: Issues, https://github.com/elijah-mullens/paddle/issues
-Author-email: Elijah Mullens <eem85@cornell.edu>, Cheng Li <chengcli@umich.edu>
-License-File: LICENSE
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Science/Research
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Topic :: Scientific/Engineering :: Astronomy
-Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
-Classifier: Topic :: Scientific/Engineering :: Physics
-Requires-Python: >=3.9
-Requires-Dist: kintera>=1.1.5
-Requires-Dist: scipy
-Requires-Dist: snapy>=0.8.1
-Requires-Dist: torch<=2.7.1,>=2.7.0
-Provides-Extra: dev
-Requires-Dist: pytest>=7; extra == 'dev'
-Description-Content-Type: text/markdown
-
-# paddle
-Python Atmospheric Dynamics: Discovering and Learning about Exoplanets. An open-source, user-friendly python version of canoe.
-
-## Install docker and docker-compose plugin
-1. install docker with compose
-```bash
-curl -fsSL https://get.docker.com | sudo sh
-```
-
-1. start docker
-sudo systemctl start docker
-
-## Test package
-1. Create a python virtual environment
-```bash
-python -m venv pyenv
-```
-
-2. Install paddle package
-```bash
-pip install paddle
-```
-
-3. Run test
-```bash
-cd tests
-python test_saturn_adiabat.py
-```
-
-## Docker user guide
-
-2. Create a docker container
-```bash
-make up
-```
-
-3. Terminate a docker container
-```bash
-make down
-```
-
-4. Start a docker container
-```bash
-make start
-```
-
-5. Build a new docker image (rarely used)
-```bash
-make build
-```
-
-## For Developer
-
-### Clone repository
-```bash
-https://github.com/elijah-mullens/paddle
-```
-
-### Cache your github credential
-```bash
-git config credential.helper 'cache --timeout=86400'
-```
-
-### Install paddle package
-
-### Install pre-commit hook
-```bash
-pip install pre-commit
-```
-
-### Install pre-commit hook
-```bash
-pre-commit install
-```
-
-## Troubleshooting
-1. If you do not have docker compose
-Remove your current docker installation, it could be docker or docker.io