Skip to content

Commit

Permalink
* Documentation, version numbers, and docker file updates. (#559)
Browse files Browse the repository at this point in the history
* File creation mode should be "w" here too. Interesting, "append"
  mode causes a test failure in the Docker container, but not baremetal
  Ubuntu.
  • Loading branch information
jmansour committed Aug 16, 2021
1 parent 78e0a41 commit 8213476
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 21 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM underworldcode/underworld2:dev
FROM underworldcode/underworld2:2.11.0b

# Set the UW_MACHINE env variable for metrics
ENV UW_MACHINE binder
6 changes: 3 additions & 3 deletions LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ Underworld has been in development since 2003. It has always been released under

### Copyright holders

Copyright Australian National University, 2020
Copyright Melbourne University, 2014-2020
Copyright Monash University, 2003-2020
Copyright Australian National University, 2020-2021
Copyright Melbourne University, 2014-2021
Copyright Monash University, 2003-2021
Copyright VPAC, 2003-2009

### References
Expand Down
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,18 +29,15 @@ In particular, the *Getting Started* section of the User Guide might be useful p
Trying out Underworld2
----------------------

You can try out the code immediately via a Jupyter Binder cloud instance. Be aware that it can take a little while for the site to fire up and that it will time-out after 30 minutes of inactivity and reset if you log back in.
You can try out the code immediately via a Jupyter Binder cloud instance. The Binder environment is identical to that obtained through running an Underworld Docker image locally.
Note that it can take a while for the site to fire up and that it will time-out after 30 minutes of inactivity and reset if you log back in.

| | |
|-|-|
| [![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/underworldcode/underworld2/v2.10.0b) | v2.10.0b (Py3) |
| [![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/underworldcode/underworld2/v2.9.2b) | v2.9.2b (Py3) |
| [![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/underworldcode/underworld2/v2.8.2b) | v2.8.2b (Py3) |
| [![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/underworldcode/underworld2/v2.7.1b) | v2.7.1b (Py2) |
| [![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/underworldcode/underworld2/development) | dev (Py3) |


Note that the Binder environment is identical to that obtained through running an Underworld Docker image locally.
| [![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/underworldcode/underworld2/v2.11.0b) | v2.11.0b |
| [![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/underworldcode/underworld2/v2.10.0b) | v2.10.0b |
| [![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/underworldcode/underworld2/v2.9.2b) | v2.9.2b |
| [![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/underworldcode/underworld2/development) | dev |


Getting Underworld2
Expand Down
6 changes: 1 addition & 5 deletions docs/install_guides/pawsey_magnus_container.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,14 @@ user@magnus-1:~$ module load singularity
2. Pull down the required image. Note that images are generally around 1GB, so you might
consider storing them somewhere in `/group` or `/scratch`.
```shell
user@magnus-1:~$ singularity pull /WHERE/TO/STORE/YOUR/IMAGE/IMAGENAME.sif docker://underworldcode/underworld2
user@magnus-1:~$ singularity pull /WHERE/TO/STORE/YOUR/IMAGE/IMAGENAME.sif docker://underworldcode/underworld2:latest
```

3. Use the image. Note that this will normally be a command line in your
queue submission script. Don't forget to also load the Singularity module.
Note also the setting of the environment variable `UW_VIS_PORT` which is
required for correct vis operation.
Note also that we currently need to set the `SINGULARITYENV_LD_LIBRARY_PATH`
variable which prevents unwanted host libraries being loaded at runtime.
```shell
user@magnus-1:~$ export SINGULARITYENV_LD_LIBRARY_PATH=/opt/cray/pe/mpt/7.7.0/gni/mpich-gnu-abi/4.9/lib:/opt/cray/xpmem/2.2.15-6.0.7.1_5.16__g7549d06.ari/lib64:/opt/cray/ugni/6.0.14.0-6.0.7.1_3.18__gea11d3d.ari/lib64:/opt/cray/udreg/2.3.2-6.0.7.1_5.18__g5196236.ari/lib64:/opt/cray/pe/pmi/5.0.13/lib64:/opt/cray/alps/6.6.43-6.0.7.1_5.54__ga796da32.ari/lib64:/opt/cray/wlm_detect/1.3.3-6.0.7.1_5.8__g7109084.ari/lib64:/usr/lib64
user@magnus-1:~$ export UW_VIS_PORT=0
user@magnus-1:~$ srun singularity exec /WHERE/TO/STORE/YOUR/IMAGE/IMAGENAME.sif python3 YOURSCRIPT.py
```
Expand All @@ -48,7 +45,6 @@ user@magnus-1:~$ module load singularity

3. Launch the Singularity shell. Note the `--pty` required for pseudo terminal mode.
```shell
user@magnus-1:~$ export SINGULARITYENV_LD_LIBRARY_PATH=/opt/cray/pe/mpt/7.7.0/gni/mpich-gnu-abi/4.9/lib:/opt/cray/xpmem/2.2.15-6.0.7.1_5.16__g7549d06.ari/lib64:/opt/cray/ugni/6.0.14.0-6.0.7.1_3.18__gea11d3d.ari/lib64:/opt/cray/udreg/2.3.2-6.0.7.1_5.18__g5196236.ari/lib64:/opt/cray/pe/pmi/5.0.13/lib64:/opt/cray/alps/6.6.43-6.0.7.1_5.54__ga796da32.ari/lib64:/opt/cray/wlm_detect/1.3.3-6.0.7.1_5.8__g7109084.ari/lib64:/usr/lib64
user@magnus-1:~$ export UW_VIS_PORT=0
user@magnus-1:~$ srun --pty singularity shell /WHERE/TO/STORE/YOUR/IMAGE/IMAGENAME.sif
```
Expand Down
2 changes: 1 addition & 1 deletion underworld/_version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "2.11.0-dev"
__version__ = "2.11.0b"
3 changes: 1 addition & 2 deletions underworld/swarm/_swarmvariable.py
Original file line number Diff line number Diff line change
Expand Up @@ -440,8 +440,7 @@ def save( self, filename, collective=False, swarmHandle=None, units=None, **kwar
for i in range(comm.rank):
offset += procCount[i]

# open parallel hdf5 file
with h5File(name=filename, mode="a") as h5f:
with h5File(name=filename, mode="w") as h5f:
# write the entire local swarm to the appropriate offset position
globalShape = (particleGlobalCount, self.data.shape[1])
dset = h5_require_dataset(h5f, "data", shape=globalShape, dtype=self.data.dtype)
Expand Down

0 comments on commit 8213476

Please sign in to comment.