scimba 0.4.0__tar.gz

scimba-0.4.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Emmanuel Franck
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

scimba-0.4.0/PKG-INFO

@@ -0,0 +1,136 @@
+Metadata-Version: 2.1
+Name: scimba
+Version: 0.4.0
+Summary: This library implements some common tools for scientific machine learning
+Author: Emmanuel Franck
+License: MIT
+Project-URL: Homepage, https://gitlab.inria.fr/sciml/scimba
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: torch==2.0.1
+Requires-Dist: scipy
+Requires-Dist: tqdm
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: scikit-learn; extra == "test"
+Provides-Extra: doc
+Requires-Dist: sphinx; extra == "doc"
+Requires-Dist: sphinx-autobuild; extra == "doc"
+Requires-Dist: furo; extra == "doc"
+Provides-Extra: examples
+Requires-Dist: h5py; extra == "examples"
+Requires-Dist: PyYAML; extra == "examples"
+Requires-Dist: scikit-learn; extra == "examples"
+
+# ScimBa
+
+[Documentation](https://sciml.gitlabpages.inria.fr/scimba)
+[![pylint](https://sciml.gitlabpages.inria.fr/scimba/badges/pylint.svg)](https://sciml.gitlabpages.inria.fr/scimba/lint/)
+
+This librairies impliment varying SciML methods for varying PDE problem and also tools to build hybrid numerical methods.
+
+## Current Content
+
+- **Nets**: MLP networks, Discontinuous MLP, RBF networks, some activations functions and a basic trainer
+- **Sampling and domain**: general uniform sampling methods for PINNs and Neural Operators. Sampling based on approximated signed distance function for general geometries.
+- **PDEs**: the librairiy implement différent type of model: ODE, spatial pde, times-apce pde, stationary kinetic PDE and kinetic PDE.
+- **Specific networks for PINNs**: For all the equations we implement PINNs networks based on: MLP, Discontinuous MLP and nonlinear radial basis function.
+We implement also the Fourier network with general features (Fourier but also Gaussian etc)
+- **Trainer**: for each type of PDE we gives a specific trainer.
+- **Generative Nets**: Normalized flows, Gaussian mixture. The classical and conditional approaches are proposed. Trainer based on the maximum likelihood principle.
+- **Neural Operator**: Continuous Auto-encoder based on PointNet encoder and coordinate based decoder. Physic informed DeepOnet for ODE, spatial and time space PDE.
+- **Neural Galerkin**: Method Neural Galerkin for time PDE based on the same network than PINNs.
+
+
+## Ongoing work for 2024
+- **Nets**: New activation function used for implicit representation, Symbolic models, Sindy
+- **Sampling and domain**: learning of signed distance function using PINNs, adaptive sampling
+- **Specific networks for PINNs**: Multiscale architecture, spectral architecture for kinetic, specific architecture.
+- **Trainer**: Trainer with sparsity constraints and globalization method. Loss Balancing
+- **Generative Nets**: Energy models, score matching, more complex normalized flow, Continuous VAE
+- **Neural Operator**: physic informed DeepGreen operator, FNO, GINO based on FNO, NO with neural implicit representation. Kinetic case
+- **Neural Galerkin**: Adaptive sampling, randomization, Least Square solver, implicit scheme. CROM Space time reduced Galerkin model. Greedy basis.
+
+
+## References
+
+### PINNs and MLP
+
+- https://www.sciencedirect.com/science/article/abs/pii/S0021999118307125
+- https://arxiv.org/abs/2209.03984
+- https://arxiv.org/abs/1912.00873
+- https://arxiv.org/abs/1912.00873
+- https://arxiv.org/abs/2109.01050
+- https://arxiv.org/abs/2203.01360
+- https://arxiv.org/abs/2103.09959
+- https://openreview.net/forum?id=vsMyHUq_C1c
+
+### Neural Galerkin
+
+- https://arxiv.org/abs/2306.15630
+- https://arxiv.org/abs/2306.03749
+- https://arxiv.org/abs/2207.13828
+- https://arxiv.org/abs/2201.07953
+- https://arxiv.org/abs/2104.13515
+
+### DeepOnet
+
+- https://www.nature.com/articles/s42256-021-00302-5
+- https://www.science.org/doi/10.1126/sciadv.abi8605
+- https://arxiv.org/abs/2205.11404
+- https://arxiv.org/abs/2206.03551
+
+### FNO and diverse geometry
+
+- https://openreview.net/forum?id=c8P9NQVtmnO
+- https://arxiv.org/abs/2207.05209
+- https://arxiv.org/abs/2212.04689
+- https://arxiv.org/abs/2305.00478
+- https://arxiv.org/abs/2306.05697
+- https://arxiv.org/abs/2305.19663
+
+### Other NO
+
+- https://openreview.net/forum?id=LZDiWaC9CGL
+- https://arxiv.org/abs/2205.10573
+- https://arxiv.org/abs/2205.02191
+- https://openreview.net/forum?id=kIo_C6QmMOM
+- https://arxiv.org/abs/2303.10528
+- https://arxiv.org/abs/2302.05925
+
+## Install the project
+
+```bash
+git clone https://gitlab.inria.fr/sciml/scimba.git
+cd scimba
+```
+
+## Install the package
+
+```bash
+pip install -e .
+```
+
+## Launch tests
+
+```bash
+pip install -e ".[test]"
+pytest
+```
+
+## Generate documentation
+
+```bash
+pip install -e ".[doc]"
+cd docs
+env PYTORCH_JIT=0 make html
+```
+
+html docs are generated in \_build/html

scimba-0.4.0/README.md

@@ -0,0 +1,105 @@
+# ScimBa
+
+[Documentation](https://sciml.gitlabpages.inria.fr/scimba)
+[![pylint](https://sciml.gitlabpages.inria.fr/scimba/badges/pylint.svg)](https://sciml.gitlabpages.inria.fr/scimba/lint/)
+
+This librairies impliment varying SciML methods for varying PDE problem and also tools to build hybrid numerical methods.
+
+## Current Content
+
+- **Nets**: MLP networks, Discontinuous MLP, RBF networks, some activations functions and a basic trainer
+- **Sampling and domain**: general uniform sampling methods for PINNs and Neural Operators. Sampling based on approximated signed distance function for general geometries.
+- **PDEs**: the librairiy implement différent type of model: ODE, spatial pde, times-apce pde, stationary kinetic PDE and kinetic PDE.
+- **Specific networks for PINNs**: For all the equations we implement PINNs networks based on: MLP, Discontinuous MLP and nonlinear radial basis function.
+We implement also the Fourier network with general features (Fourier but also Gaussian etc)
+- **Trainer**: for each type of PDE we gives a specific trainer.
+- **Generative Nets**: Normalized flows, Gaussian mixture. The classical and conditional approaches are proposed. Trainer based on the maximum likelihood principle.
+- **Neural Operator**: Continuous Auto-encoder based on PointNet encoder and coordinate based decoder. Physic informed DeepOnet for ODE, spatial and time space PDE.
+- **Neural Galerkin**: Method Neural Galerkin for time PDE based on the same network than PINNs.
+
+
+## Ongoing work for 2024
+- **Nets**: New activation function used for implicit representation, Symbolic models, Sindy
+- **Sampling and domain**: learning of signed distance function using PINNs, adaptive sampling
+- **Specific networks for PINNs**: Multiscale architecture, spectral architecture for kinetic, specific architecture.
+- **Trainer**: Trainer with sparsity constraints and globalization method. Loss Balancing
+- **Generative Nets**: Energy models, score matching, more complex normalized flow, Continuous VAE
+- **Neural Operator**: physic informed DeepGreen operator, FNO, GINO based on FNO, NO with neural implicit representation. Kinetic case
+- **Neural Galerkin**: Adaptive sampling, randomization, Least Square solver, implicit scheme. CROM Space time reduced Galerkin model. Greedy basis.
+
+
+## References
+
+### PINNs and MLP
+
+- https://www.sciencedirect.com/science/article/abs/pii/S0021999118307125
+- https://arxiv.org/abs/2209.03984
+- https://arxiv.org/abs/1912.00873
+- https://arxiv.org/abs/1912.00873
+- https://arxiv.org/abs/2109.01050
+- https://arxiv.org/abs/2203.01360
+- https://arxiv.org/abs/2103.09959
+- https://openreview.net/forum?id=vsMyHUq_C1c
+
+### Neural Galerkin
+
+- https://arxiv.org/abs/2306.15630
+- https://arxiv.org/abs/2306.03749
+- https://arxiv.org/abs/2207.13828
+- https://arxiv.org/abs/2201.07953
+- https://arxiv.org/abs/2104.13515
+
+### DeepOnet
+
+- https://www.nature.com/articles/s42256-021-00302-5
+- https://www.science.org/doi/10.1126/sciadv.abi8605
+- https://arxiv.org/abs/2205.11404
+- https://arxiv.org/abs/2206.03551
+
+### FNO and diverse geometry
+
+- https://openreview.net/forum?id=c8P9NQVtmnO
+- https://arxiv.org/abs/2207.05209
+- https://arxiv.org/abs/2212.04689
+- https://arxiv.org/abs/2305.00478
+- https://arxiv.org/abs/2306.05697
+- https://arxiv.org/abs/2305.19663
+
+### Other NO
+
+- https://openreview.net/forum?id=LZDiWaC9CGL
+- https://arxiv.org/abs/2205.10573
+- https://arxiv.org/abs/2205.02191
+- https://openreview.net/forum?id=kIo_C6QmMOM
+- https://arxiv.org/abs/2303.10528
+- https://arxiv.org/abs/2302.05925
+
+## Install the project
+
+```bash
+git clone https://gitlab.inria.fr/sciml/scimba.git
+cd scimba
+```
+
+## Install the package
+
+```bash
+pip install -e .
+```
+
+## Launch tests
+
+```bash
+pip install -e ".[test]"
+pytest
+```
+
+## Generate documentation
+
+```bash
+pip install -e ".[doc]"
+cd docs
+env PYTORCH_JIT=0 make html
+```
+
+html docs are generated in \_build/html

scimba-0.4.0/pyproject.toml

@@ -0,0 +1,43 @@
+[build-system]
+requires = ["setuptools>=61.2"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "scimba"
+authors = [{ name = "Emmanuel Franck" }]
+description = "This library implements some common tools for scientific machine learning"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+requires-python = ">=3.9"
+dependencies = ["matplotlib", "numpy", "torch==2.0.1", "scipy", "tqdm"]
+dynamic = ["version"]
+
+[project.readme]
+file = "README.md"
+content-type = "text/markdown"
+
+[project.license]
+text = "MIT"
+
+[project.urls]
+Homepage = "https://gitlab.inria.fr/sciml/scimba"
+
+[project.optional-dependencies]
+test = ["pytest", "pytest-cov", "scikit-learn"]
+doc = ["sphinx", "sphinx-autobuild", "furo"]
+examples = ["h5py", "PyYAML", "scikit-learn"]
+
+[tool.setuptools]
+include-package-data = true
+license-files = ["LICENSE"]
+package-dir = { "" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+namespaces = false
+
+[tool.setuptools.dynamic.version]
+attr = "scimba.__version__"

scimba-0.4.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

scimba-0.4.0/src/scimba/__init__.py

@@ -0,0 +1,14 @@
+import torch
+
+__version__ = "0.4.0"
+
+device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
+torch.set_default_device(device)
+torch.set_default_dtype(torch.float)
+
+print("Using device:", device)
+
+if torch.cuda.is_available():
+    print(f"cuda devices:        {torch.cuda.device_count()}")
+    print(f"cuda current device: {torch.cuda.current_device()}")
+    print(f"cuda device name:    {torch.cuda.get_device_name(0)}")

scimba-0.4.0/src/scimba/equations/__init__.py

@@ -0,0 +1,3 @@
+"""
+Abstract classes for equations (ODEs and PDEs), with some examples, and definitions of space and time domains.
+"""