Skip to content

Commit

Permalink
Add remaining doc sections.
Browse files Browse the repository at this point in the history
  • Loading branch information
joaander committed May 10, 2024
1 parent fb54e91 commit 2e264b0
Show file tree
Hide file tree
Showing 8 changed files with 518 additions and 10 deletions.
6 changes: 3 additions & 3 deletions doc/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,14 @@

# Appendix

- [Release notes]()
- [Release notes](release-notes.md)
- [Migrating from signac-flow](signac-flow.md)
- [For developers](developers/index.md)
- [Contributing](developers/contributing.md)
- [Code style](developers/style.md)
- [Testing](developers/testing.md)
- [Documentation](developers/documentation.md)
- [License]()
- [License](license.md)

-----
[Contributors]()
[Contributors](contributors.md)
4 changes: 2 additions & 2 deletions doc/src/clusters/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ total_cpus <= maximum_cpus_per_job

`cluster.partition.require_cpus_multiple_of`: **integer** - All jobs submitted to this
partition **must** use an integer multiple of the given number of cpus:
```
```plaintext
total_cpus % require_cpus_multiple_of == 0
```

Expand Down Expand Up @@ -118,7 +118,7 @@ total_gpus <= maximum_gpus_per_job

`cluster.partition.require_gpus_multiple_of`: **integer** - All jobs submitted to this
partition **must** use an integer multiple of the given number of gpus:
```
```plaintext
total_gpus % require_gpus_multiple_of == 0
```

Expand Down
5 changes: 5 additions & 0 deletions doc/src/contributors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Contributors

The following people have contributed to the development of **row**:

* Joshua A. Anderson, University of Michigan
2 changes: 1 addition & 1 deletion doc/src/guide/concepts/json-pointers.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
way for you to access elements of a directory's JSON value.

For example, given the JSON document:
```
```json
{
"a": 1,
"b": {
Expand Down
6 changes: 3 additions & 3 deletions doc/src/guide/tutorial/submit.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Make sure that the script is requesting the correct resources and is routed to t
correct **partition**.

For example, the example workflow might generate a job script like this on Anvil:
```
```bash
#!/bin/bash
#SBATCH --job-name=hello-directory0+2
#SBATCH --partition=shared
Expand Down Expand Up @@ -90,7 +90,7 @@ on the number of CPU cores quested.
### Submitting jobs

When you are *sure* that the **job script** is correct, submit it with:
```
```bash
row submit
```

Expand Down Expand Up @@ -123,7 +123,7 @@ Similarly,
row show directories hello
```
will show something like:
```
```plaintext
Directory Status Job ID
directory0 submitted anvil/5044933
directory1 submitted anvil/5044933
Expand Down
2 changes: 1 addition & 1 deletion doc/src/launchers/built-in.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ to see the current launcher configuration.

When using OpenMP/MPI hybrid applications, place `"openmp"` first in the list of
launchers (`launchers = ["openmp", "mpi"]`) to generate the appropriate command:
```
```bash
OMP_NUM_THREADS=T srun --ntasks=N --cpus-per-task=T command $directory
```
Loading

0 comments on commit 2e264b0

Please sign in to comment.