foscat 2025.10.2__tar.gz → 2026.1.1__tar.gz

{foscat-2025.10.2/src/foscat.egg-info → foscat-2026.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: foscat
-Version: 2025.10.2
+Version: 2026.1.1
 Summary: Generate synthetic Healpix or 2D data using Cross Scattering Transform
 Author-email: Jean-Marc DELOUIS <jean.marc.delouis@ifremer.fr>
 Maintainer-email: Theo Foulquier <theo.foulquier@ifremer.fr>
@@ -91,74 +91,6 @@ git clone https://github.com/jmdelouis/FOSCAT_DEMO.git
 
 ```
 
-# Spherical data example
-
-## compute a synthetic image
-
-```
-python demo.py -n=32 -k -c -s=100
-```
-
-The _demo.py_ script serves as a demonstration of the capabilities of the foscat library. It utilizes the Cross Wavelet Scattering Transform to generate a Healpix map that possesses the same characteristics as a specified input map.
-
-- `-n=32` computes map with nside=32.
-- `-k` uses 5x5 kernel.
-- `-c` uses Scattering Covariance.
-- `-l` uses LBFGS minimizer.
-- `-s=100` computes 100 steps.
-
-```
-python demo.py -n=8 [-c|--cov][-s|--steps=3000][-S=1234|--seed=1234][-k|--k5x5][-d|--data][-o|--out][-r|--orient] [-p|--path][-a|--adam]
-
-```
-
-- The "-n" option specifies the nside of the input map. The maximum nside value is 256 with the default map.
-- The "--cov" option (optional) uses scat_cov instead of scat.
-- The "--steps" option (optional) specifies the number of iterations. If not specified, the default value is 1000.
-- The "--seed" option (optional) specifies the seed of the random generator.
-- The "--path" option (optional) allows you to define the path where the output files will be written. The default path is "data".
-- The "--k5x5" option (optional) uses a 5x5 kernel instead of a 3x3.
-- The "--data" option (optional) specifies the input data file to be used. If not specified, the default file "LSS_map_nside128.npy" will be used.
-- The "--out" option (optional) specifies the output file name. If not specified, the output file will be saved in "demo".
-- The "--orient" option (optional) specifies the number of orientations. If not specified, the default value is 4.
-- The "--adam" option (optional) makes the synthesis using the ADAM optimizer instead of the L_BFGS.
-
-## plot the result
-
-The following script generates a series of plots that showcase different aspects of the synthesis process using the _demo.py_ script.
-
-> python test2D.py
-
-```
-python plotdemo.py -n=32 -c
-```
-
-# 2D field demo
-
-> python test2Dplot.py
-
-# compute a synthetic turbulent field
-
-The python scripts _demo2D.py_ included in this package demonstrate how to use the foscat library to generate a 2D synthetic fields that have patterns with the same statistical properties as a specified 2D image. In this particular case, the input field is a sea surface temperature extracted from a north atlantic ocean simulation.
-
-> python testHealpix.py
-
-```
-python demo2d.py -n=32 -k -c
-```
-
-> python testHplot.py
-
-The following script generates a series of plots that showcase different aspects of the synthesis process using the _demo2D.py_ script.
-
-```
-python plotdemo2d.py -n=32 -c
-```
-
-For more information, see the [documentation](https://foscat-documentation.readthedocs.io/en/latest/index.html).
-
-> mpirun -np 3 testHealpix_mpi.py
-
 ## Authors and acknowledgment
 
 Authors: J.-M. Delouis, P. Campeti, T. Foulquier, J. Mangin, L. Mousset, T. Odaka, F. Paul, E. Allys

{foscat-2025.10.2 → foscat-2026.1.1}/README.md

@@ -62,74 +62,6 @@ git clone https://github.com/jmdelouis/FOSCAT_DEMO.git
 
 ```
 
-# Spherical data example
-
-## compute a synthetic image
-
-```
-python demo.py -n=32 -k -c -s=100
-```
-
-The _demo.py_ script serves as a demonstration of the capabilities of the foscat library. It utilizes the Cross Wavelet Scattering Transform to generate a Healpix map that possesses the same characteristics as a specified input map.
-
-- `-n=32` computes map with nside=32.
-- `-k` uses 5x5 kernel.
-- `-c` uses Scattering Covariance.
-- `-l` uses LBFGS minimizer.
-- `-s=100` computes 100 steps.
-
-```
-python demo.py -n=8 [-c|--cov][-s|--steps=3000][-S=1234|--seed=1234][-k|--k5x5][-d|--data][-o|--out][-r|--orient] [-p|--path][-a|--adam]
-
-```
-
-- The "-n" option specifies the nside of the input map. The maximum nside value is 256 with the default map.
-- The "--cov" option (optional) uses scat_cov instead of scat.
-- The "--steps" option (optional) specifies the number of iterations. If not specified, the default value is 1000.
-- The "--seed" option (optional) specifies the seed of the random generator.
-- The "--path" option (optional) allows you to define the path where the output files will be written. The default path is "data".
-- The "--k5x5" option (optional) uses a 5x5 kernel instead of a 3x3.
-- The "--data" option (optional) specifies the input data file to be used. If not specified, the default file "LSS_map_nside128.npy" will be used.
-- The "--out" option (optional) specifies the output file name. If not specified, the output file will be saved in "demo".
-- The "--orient" option (optional) specifies the number of orientations. If not specified, the default value is 4.
-- The "--adam" option (optional) makes the synthesis using the ADAM optimizer instead of the L_BFGS.
-
-## plot the result
-
-The following script generates a series of plots that showcase different aspects of the synthesis process using the _demo.py_ script.
-
-> python test2D.py
-
-```
-python plotdemo.py -n=32 -c
-```
-
-# 2D field demo
-
-> python test2Dplot.py
-
-# compute a synthetic turbulent field
-
-The python scripts _demo2D.py_ included in this package demonstrate how to use the foscat library to generate a 2D synthetic fields that have patterns with the same statistical properties as a specified 2D image. In this particular case, the input field is a sea surface temperature extracted from a north atlantic ocean simulation.
-
-> python testHealpix.py
-
-```
-python demo2d.py -n=32 -k -c
-```
-
-> python testHplot.py
-
-The following script generates a series of plots that showcase different aspects of the synthesis process using the _demo2D.py_ script.
-
-```
-python plotdemo2d.py -n=32 -c
-```
-
-For more information, see the [documentation](https://foscat-documentation.readthedocs.io/en/latest/index.html).
-
-> mpirun -np 3 testHealpix_mpi.py
-
 ## Authors and acknowledgment
 
 Authors: J.-M. Delouis, P. Campeti, T. Foulquier, J. Mangin, L. Mousset, T. Odaka, F. Paul, E. Allys

{foscat-2025.10.2 → foscat-2026.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "foscat"
-version = "2025.10.2"
+version = "2026.01.1"
 description = "Generate synthetic Healpix or 2D data using Cross Scattering Transform"
 readme = "README.md"
 license = { text = "BSD-3-Clause" }