README.md updated

Author: spaceswimmer

README.md

@@ -1,2 +1,74 @@
-# Это мой репозиторий, где я занимаюсь акустическим и упругим сейсмическим моделированием с помощью метода конечных разностей
-Результаты и исходные данные скрыты по требованию заказчика
+# Seismic Modeling with Devito  
+
+## Repository Overview  
+This repository contains Python-based seismic modeling workflows utilizing the **Devito** framework for high-performance finite difference computations. The project focuses on wave propagation simulations, reverse time migration (RTM), and full waveform inversion (FWI) in seismic exploration.  
+
+Due to confidentiality agreements, certain datasets and modeling results are not publicly available. For access to specific outputs or collaboration inquiries, please contact the repository owner.  
+
+🔗 **Repository Link:** [https://github.com/spaceswimmer/Seismic_modeling](https://github.com/spaceswimmer/Seismic_modeling)  
+
+## System Requirements  
+- **Operating System:** Unix-based (Linux/macOS)  
+- **GPU Acceleration:** NVIDIA CUDA Toolkit (v11.0+)  
+- **Python Dependencies:**  
+  - Devito (v4.8+)  
+  - NumPy, SciPy, Matplotlib
+  (using requirements.txt prefered) 
+
+## Repository Structure  
+```  
+Seismic_modeling/  
+├── /data/                  # data to run python scripts
+├── /docs/                  # Technical notes and theory references
+├── /results/               # Results of scripts  
+├── /src/                   # Core Python scripts  
+│   ├── 2d_acoustic             # 2d Acoustic seismic modeling scripts
+│   ├── 2d_elastic              # 2d Elastic seismic modeling scripts
+│   ├── 2d_vankor               # 2d Elastic seismic modeling scripts on vankor data
+│   ├── 2d_vibro                # 2d Elastic seismic modeling scripts for vibrator source
+│   ├── 2d_VSP_RTM              # 2d Reverse time migration scripts
+│   ├── 3d acoustic             # 3d Elastic seismic modeling scripts
+│   ├── Experimental code       # VIP code
+│   └── scratch/                # utility library with custom solvers and functions
+├── /tests/                 # Unit and integration tests (pytest) (VIP not implemented yet) 
+├── /requiremets_conda.txt  # Conda env requirements
+├── /requiremets.txt        # Python venv requirements
+└── README.md               # Project documentation  
+```  
+
+## Key Features  
+- **Optimized PDE Solvers:** Leverages Devito's symbolic computation for wave equation discretization.  
+- **HPC-Ready:** Supports multi-GPU parallelism via CUDA and MPI.  
+- **Reproducible Workflows:** Configuration-driven execution for consistent benchmarking.  
+
+## Installation  
+1. **Set up CUDA Toolkit:**  
+    Install CUDA Toolkit from official NVIDIA website:
+    🔗 **CUDA Toolkit:** [https://developer.nvidia.com/cuda-downloads?target_os=Linux](CUDA Toolkit)  
+2. **Create Conda Environment or Python virtual environment:**  
+    Conda approach:
+    ```bash  
+    conda create -n devito --file requirements_conda.txt  
+    conda activate devito   
+    ```
+    Python venv approach:
+    ```bash
+    pip install virtualenv
+    virtualenv .venv
+    source .venv/bin/activate
+    pip install -r requirements.txt
+    ```
+
+## Usage  
+Execute simulations with predefined configs:  
+```bash  
+python src/2d_elastic/AM_model.py 250 0 0.02 "../data/AM_model/recorders.txt" -r "../results/2d_elastic" -gpu   
+```
+
+## License  
+Proprietary code. Unauthorized redistribution prohibited.  
+
+For collaboration or data access requests, please open a GitHub Issue or contact the maintainer.  
+
+---  
+*Note: Computational results and proprietary velocity models are omitted per client agreements.*

src/Code_examples/01_modelling.out.ipynb renamed to docs/Code_examples/01_modelling.out.ipynb

@@ -1,183 +1,61 @@
-addict==2.4.0
-ai-einblick-prompt==0.1.12
-anyio==4.4.0
 anytree==2.12.1
-argon2-cffi==23.1.0
-argon2-cffi-bindings==21.2.0
-arrow==1.3.0
-asciitree==0.3.3
-asttokens==2.4.1
-async-lru==2.0.4
-attrs==23.2.0
-Babel==2.15.0
-beautifulsoup4==4.12.3
-bleach==6.1.0
-bokeh==3.5.1
-Bottleneck==1.4.0
-certifi==2024.7.4
-cffi==1.16.0
-cfgv==3.4.0
-cftime==1.6.4
+asttokens @ file:///home/conda/feedstock_root/build_artifacts/asttokens_1733250440834/work
 cgen==2020.1
-charset-normalizer==3.3.2
-click==8.1.7
-cloudpickle==3.0.0
+click==8.1.8
+cloudpickle==3.1.1
 codepy==2023.1
-comm==0.2.2
-contourpy==1.2.1
-coverage==7.6.0
+comm @ file:///home/conda/feedstock_root/build_artifacts/comm_1733502965406/work
+contourpy==1.3.1
 cycler==0.12.1
-dask==2024.7.1
-dask-expr==1.1.9
-debugpy==1.8.2
-decorator==5.1.1
-defusedxml==0.7.1
-devito==4.8.11
-distlib==0.3.8
-distributed==2024.7.1
-execnet==2.1.1
-executing==2.0.1
-fasteners==0.19
-fastjsonschema==2.20.0
-filelock==3.15.4
-flox==0.9.9
-fonttools==4.53.1
-fqdn==1.5.1
-fsspec==2024.6.1
-h11==0.14.0
-h5netcdf==1.3.0
-h5py==3.11.0
-httpcore==1.0.5
-httpx==0.27.0
-hypothesis==6.108.5
-identify==2.6.0
-idna==3.7
+debugpy @ file:///croot/debugpy_1736267418885/work
+decorator @ file:///home/conda/feedstock_root/build_artifacts/decorator_1740384970518/work
+devito==4.8.13
+exceptiongroup @ file:///home/conda/feedstock_root/build_artifacts/exceptiongroup_1733208806608/work
+executing @ file:///home/conda/feedstock_root/build_artifacts/executing_1733569351617/work
+fonttools==4.56.0
+importlib_metadata @ file:///home/conda/feedstock_root/build_artifacts/importlib-metadata_1737420181517/work
 iniconfig==2.0.0
-ipykernel==6.29.5
-ipython==8.26.0
-ipywidgets==8.1.3
-isoduration==20.11.0
-jedi==0.19.1
-Jinja2==3.1.4
-json5==0.9.25
-jsonpointer==3.0.0
-jsonschema==4.23.0
-jsonschema-specifications==2023.12.1
-jupyter==1.0.0
-jupyter-console==6.6.3
-jupyter-events==0.10.0
-jupyter-lsp==2.2.5
-jupyter-resource-usage==1.1.0
-jupyter_client==8.6.2
-jupyter_core==5.7.2
-jupyter_server==2.14.2
-jupyter_server_terminals==0.5.3
-jupyterlab==4.2.4
-jupyterlab_pygments==0.3.0
-jupyterlab_server==2.27.3
-jupyterlab_widgets==3.0.11
-kiwisolver==1.4.5
-llvmlite==0.43.0
-locket==1.0.0
-lz4==4.3.3
-MarkupSafe==2.1.5
-matplotlib==3.9.1
-matplotlib-inline==0.1.7
-mistune==3.0.2
-more-itertools==10.3.0
+ipykernel @ file:///home/conda/feedstock_root/build_artifacts/ipykernel_1719845459717/work
+ipython @ file:///home/conda/feedstock_root/build_artifacts/bld/rattler-build_ipython_1741457126/work
+ipython_pygments_lexers @ file:///home/conda/feedstock_root/build_artifacts/ipython_pygments_lexers_1737123620466/work
+jedi @ file:///home/conda/feedstock_root/build_artifacts/jedi_1733300866624/work
+jupyter_client @ file:///home/conda/feedstock_root/build_artifacts/jupyter_client_1733440914442/work
+jupyter_core @ file:///home/conda/feedstock_root/build_artifacts/jupyter_core_1727163409502/work
+kiwisolver==1.4.8
+matplotlib==3.10.1
+matplotlib-inline @ file:///home/conda/feedstock_root/build_artifacts/matplotlib-inline_1733416936468/work
 mpmath==1.3.0
-msgpack==1.0.8
-multidict==6.0.5
-mypy==1.11.1
-mypy-extensions==1.0.0
-nbclient==0.10.0
-nbconvert==7.16.4
-nbformat==5.10.4
-nc-time-axis==1.4.1
-nest-asyncio==1.6.0
-netCDF4==1.7.1.post1
-nodeenv==1.9.1
-notebook==7.2.1
-notebook_shim==0.2.4
-numba==0.60.0
-numbagg==0.8.1
-numcodecs==0.13.0
-numpy==2.0.1
-numpy-groupies==0.11.2
-opt-einsum==3.3.0
-overrides==7.7.0
-packaging==24.1
-pandas==2.2.2
-pandocfilters==1.5.1
-parso==0.8.4
-partd==1.4.2
-pexpect==4.9.0
-pillow==10.4.0
-platformdirs==4.2.2
+multidict==6.1.0
+nest_asyncio @ file:///home/conda/feedstock_root/build_artifacts/nest-asyncio_1733325553580/work
+numpy==2.2.3
+packaging @ file:///home/conda/feedstock_root/build_artifacts/packaging_1733203243479/work
+parso @ file:///home/conda/feedstock_root/build_artifacts/parso_1733271261340/work
+pexpect @ file:///home/conda/feedstock_root/build_artifacts/pexpect_1733301927746/work
+pickleshare @ file:///home/conda/feedstock_root/build_artifacts/pickleshare_1733327343728/work
+pillow==11.1.0
+platformdirs @ file:///home/conda/feedstock_root/build_artifacts/platformdirs_1733232627818/work
 pluggy==1.5.0
-pooch==1.8.2
-pre-commit==3.8.0
-prometheus_client==0.20.0
-prompt_toolkit==3.0.47
-psutil==5.9.8
-ptyprocess==0.7.0
-pure_eval==0.2.3
+prompt_toolkit @ file:///home/conda/feedstock_root/build_artifacts/prompt-toolkit_1737453357274/work
+psutil==7.0.0
+ptyprocess @ file:///home/conda/feedstock_root/build_artifacts/ptyprocess_1733302279685/work/dist/ptyprocess-0.7.0-py2.py3-none-any.whl#sha256=92c32ff62b5fd8cf325bec5ab90d7be3d2a8ca8c8a3813ff487a8d2002630d1f
+pure_eval @ file:///home/conda/feedstock_root/build_artifacts/pure_eval_1733569405015/work
 py-cpuinfo==9.0.0
-pyarrow==17.0.0
-pyarrow-hotfix==0.6
-pycparser==2.22
-Pygments==2.18.0
-pyparsing==3.1.2
-pytest==8.3.2
-pytest-cov==5.0.0
-pytest-env==1.1.3
-pytest-timeout==2.3.1
-pytest-xdist==3.6.1
-python-dateutil==2.9.0.post0
-python-json-logger==2.0.7
-pytools==2024.1.11
-pytz==2024.1
-PyYAML==6.0.1
-pyzmq==26.0.3
-qtconsole==5.5.2
-QtPy==2.4.1
-referencing==0.35.1
-requests==2.32.3
-rfc3339-validator==0.1.4
-rfc3986-validator==0.1.1
-rpds-py==0.19.1
-ruff==0.5.5
-scipy==1.14.0
-seaborn==0.13.2
-segyio==1.9.12
-segysak==0.5.1
-Send2Trash==1.8.3
-setuptools==72.1.0
-six==1.16.0
-sniffio==1.3.1
-sortedcontainers==2.4.0
-soupsieve==2.5
-stack-data==0.6.3
-sympy==1.13.1
-tblib==3.0.0
-terminado==0.18.1
-tinycss2==1.3.0
-toolz==0.12.1
-tornado==6.4.1
-tqdm==4.66.4
-traitlets==5.14.3
-types-python-dateutil==2.9.0.20240316
-typing_extensions==4.12.2
-tzdata==2024.1
-uri-template==1.3.0
-urllib3==2.2.2
-virtualenv==20.26.3
-wcwidth==0.2.13
-webcolors==24.6.0
-webencodings==0.5.1
-websocket-client==1.8.0
-widgetsnbextension==4.0.11
-xarray==2024.7.0
-xyzservices==2024.6.0
-zarr==2.18.2
-zict==3.0.0
+Pygments @ file:///home/conda/feedstock_root/build_artifacts/pygments_1736243443484/work
+pyparsing==3.2.1
+pytest==8.3.5
+python-dateutil @ file:///home/conda/feedstock_root/build_artifacts/python-dateutil_1733215673016/work
+pytools==2025.1.1
+pyzmq @ file:///croot/pyzmq_1734687138743/work
+scipy==1.15.2
+segyio==1.9.13
+setuptools==75.8.0
+six @ file:///home/conda/feedstock_root/build_artifacts/six_1733380938961/work
+stack_data @ file:///home/conda/feedstock_root/build_artifacts/stack_data_1733569443808/work
+sympy==1.13.3
+tornado @ file:///croot/tornado_1733960490606/work
+tqdm==4.67.1
+traitlets @ file:///home/conda/feedstock_root/build_artifacts/traitlets_1733367359838/work
+typing_extensions @ file:///home/conda/feedstock_root/build_artifacts/typing_extensions_1733188668063/work
+wcwidth @ file:///home/conda/feedstock_root/build_artifacts/wcwidth_1733231326287/work
+wheel==0.45.1
+zipp @ file:///home/conda/feedstock_root/build_artifacts/zipp_1732827521216/work