aboutsummaryrefslogtreecommitdiff
path: root/reproduce/software/shell/docker-README.md
diff options
context:
space:
mode:
authorBoud Roukema <boud@cosmo.torun.pl>2026-01-18 22:50:48 +0600
committerMohammad Akhlaghi <mohammad@akhlaghi.org>2026-05-03 03:00:18 +0200
commitd99b69fdb52f2fd522f53bba29a42d3ba8af5361 (patch)
treec99e3b167a6af946f268a8f597de059b2a2c7dc2 /reproduce/software/shell/docker-README.md
parentd7264f9cfd6dd17fa2b5a60a8696dfde08ee18de (diff)
IMPORTANT: Python and some basic software updated, improved portabilityHEADmaneage
Summary: this commit has no effect on your project's analysis steps, just check the list of changed Python software versions (if you used them). Until now, the Python packages of Maneage had not been maintained for some time, there were several portability issues: updates to the GNU C Library needed an update to some of the basic software, and the latest macOS features caused some crashes. With this commit, along with the software version updates of [1], the removed software of [2] and newly added software of [3], the following issues in Maneage have been addressed: - README-hacking: - Published paper list: Added links to two published papers. - Publication checklist: added tips on how to squash the full LaTeX source of a Maneage'd projet (which includes many LaTeX files) into a single LaTeX file for some journals. - A new "Maneage Development Workflow" section has been added; see it for details. - paper.mk: empty macro files are not included in the built 'project.tex' since they have no effect and because they can cause problems with uploading to arXiv (which removes empty files). - verify.mk: when verification is activated: - When a macro file does not exist (can happen by mistake), an error is printed to remind the author. - Better dealing with empty macro files (no need to add their hash). - versions.conf: 26 Python packages that cannot currently be built with the new Python build system of Maneage have been separated and commented to cause an early crash if they are required; and encourage volunteers to help update them. This commit is a git "squash" of contributions from the following people - Boud Roukema: updated/added Python packages and fixed many portability issues. - Faezeh Bidjarchian: fixed some portability issues on macOS. - Giacomo Lorenzetti: tested and fixed issues in newly added software. - Khalid Masum: fixed issue with order of LD_LIBRARY_PATH in 'basic.mk'. - Mohammad Akhlaghi: fixed basic software issues and reviewed edits for the merge. - Raul Infante-Sainz: fixed portability issues on macOS. - Sepideh Eskandarlou: helped in finding the verification fixes. [1] Updated software Name Group Version (old -> new) ---- ----- -------------------- GNU Coreutils basic 9.9 -> 9.11 GNU Gettext basic 0.26 -> 1.0 GNU libunistring basic 1.4.1 -> 1.4.2 GNU M4 basic 1.4.20 -> 1.4.21 GNU Nano basic 8.7 -> 9.0 Ninja high-level 1.12.1 -> 1.13.2 OpenMPI high-level 4.1.1 -> 5.0.10 SWIG high-level 4.0.2 -> 4.3.1 Zip high-level 3.0 -> 3.0-15 Astropy python 7.0.1 -> 7.1.0 mpi4py python 3.1.3 -> 4.0.3 setuptools python 75.8.0 -> 80.8.0 [2] Removed software: 'podlators' has been removed from basic software because the necessary scripts that it provided are included in Perl's default installation. [3] New software: Name Group Version ---- ----- ------- framel high-level 8.47.3 GNU Parallel high-level 20260322 Healpix high-level 3.83-2024Nov13 Metaio high-level 8.5.0-a5da19d PCRE2 high-level 10.45 SQLite high-level 3.53.0 TCL high-level 9.1a1 TK high-level 9.1a1 tzdb high-level 2026a lalsuite high-level v7.26-15-g1e4c5e5080 astropy-healpix python 1.1.2 colorama python 0.4.6 cosmodesi-mpytools python 1.0.0-04369fc9 exceptiongroup python 1.3.0 filt-scm python 1.7.0 hatchling python 1.27.0 hatch-vcs python 0.5.0 healpy python 1.18.1 joblib python 1.5.0 igwn-ligolw python 2.1.0 igwn-segments python 2.1.0 iniconfig python 2.1.0 ligo-skymap python 2.4.0 lscsoft-glue python 4.1.0 networkx python 3.5 pandas python 2.2.3 pathspec python 0.12.1 pluggy python 1.6.0 pyfftw python 0.15.1 pygments python 2.19.2 pytest python 8.4.1 python3-fitsio python 1.3.0 pytz python 2025.2 scikit-base python 0.12.2 scikit-learn python 1.6.1 threadpoolctl python 3.6.0 tqdm python 4.67.1 trove-classifiers python 2025.5.9.12 versioneer python 0.29
Diffstat (limited to 'reproduce/software/shell/docker-README.md')
-rw-r--r--reproduce/software/shell/docker-README.md21
1 files changed, 9 insertions, 12 deletions
diff --git a/reproduce/software/shell/docker-README.md b/reproduce/software/shell/docker-README.md
index 9e09282..dd46f4f 100644
--- a/reproduce/software/shell/docker-README.md
+++ b/reproduce/software/shell/docker-README.md
@@ -35,28 +35,25 @@ software environment) to easily move it from one computer to another.
systemctl start docker
```
- 2. Using your favorite text editor, create a `run.sh` in your top Maneage
- directory (as described in the comments at the start of the `docker.sh`
- script in this directory). Just activate `--build-only` on the first
- run so it doesn't go onto doing the analysis and just sets up the
- software environment. Set the respective directory(s) based on your
- filesystem (the software directory is optional). The `run.sh` file name
- is already in `.gitignore` (because it contains local directories), so
- Git will ignore it and it won't be committed by mistake.
+ 2. At the start of the `docker.sh` script in this directory, you can see
+ the necessary command to run. Just activate `--build-only` on the first
+ run so it doesn't go onto doing the analysis (that can be done at any
+ later time). Set the respective directory(s) based on your filesystem
+ (the software directory is optional). You can put the command in a
+ `run.sh` at the top of the project (it is already in `.gitignore`:
+ because it contains local directories).
3. After the setup is complete, remove the `--build-only` and run the
command below to confirm that `maneage-base` (the OS of the container)
and `maneaged` (your project's full Maneage'd environment) images are
available. If you want different names for these images, add the
- `--project-name` and `--base-name` options to the `docker.sh` call.
+ `--project-name` and `--base-name` options to the `docker.sh` call. You
+ can see the list of available images with this command:
```shell
docker image list
```
- 4. You are now ready to do your analysis by removing the `--build-only`
- option.
-