zli
/
good_simulation_practices
forked from lfrerot/good_simulation_practices
1
0
Fork 0
Code Pull Requests Activity

gitignore and update README.md

This commit is contained in:
Zichen LI 2025-11-28 13:36:07 +01:00
parent e989dc9927
commit 602c480e49
2 changed files with 70 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
.gitignore vendored Normal file
View File

@ -0,0 +1,58 @@
# --------------------
# Python
# --------------------
__pycache__/
*.py[cod]
*.pyo
*.pyd
*.so
# Packaging
dist/
build/
*.egg
*.egg-info/
.eggs/
*.whl
# log/temp
*.log
*.tmp
*.temp
*.out
# --------------------
# virtual environment
# --------------------
JAX-venv/
venv/
.venv/
env/
ENV/
# --------------------
# Jupyter
# --------------------
.ipynb_checkpoints/
*.nb.py
# --------------------
# VS Code
# --------------------
.vscode/
.history/
*.code-workspace
# --------------------
# Operate system
# --------------------
.DS_Store
Thumbs.db
# --------------------
# editor temp files
# --------------------
*.swp
*.swo
*~

12
JAX/README.md
View File

@ -40,8 +40,20 @@ devices: [CudaDevice(id=0)]
x.device: cuda:0 x.device: cuda:0
``` ```
Structure of the project:
```
JAX/
├─ JAX-venv/
├─ src/ # Python codes
├─ notebooks/ # Experimental notebook
├─ tests/ # Unit tests
└─ pyproject.toml # Or requirements.txt
```
### Source ### Source
[1] https://uvadlc-notebooks.readthedocs.io/en/latest/ [1] https://uvadlc-notebooks.readthedocs.io/en/latest/
[2] https://www.sciencedirect.com/science/article/pii/S0045782524008260?via%3Dihub [2] https://www.sciencedirect.com/science/article/pii/S0045782524008260?via%3Dihub
[3] https://docs.jax.dev/en/latest/automatic-differentiation.html [3] https://docs.jax.dev/en/latest/automatic-differentiation.html
[4] https://docs.jax.dev/en/latest/jit-compilation.html [4] https://docs.jax.dev/en/latest/jit-compilation.html