Skip to content

Commit fa7bc75

Browse files
committed
some more psi-j -> psij replacements
1 parent 9cc6d6c commit fa7bc75

File tree

5 files changed

+23
-23
lines changed

5 files changed

+23
-23
lines changed

QuickStart.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,21 @@
33
This document will guide you through the install procedure and your first hello world example.
44

55
- [Requirements](#requirements)
6-
- [Install psi-j](#install-psi-j)
6+
- [Install psij](#install-psij)
77
- [Hello World example](#hello-world)
88

99
## Requirements
1010
- python3.7+
1111

12-
## Install psi-j
12+
## Install psij
1313

14-
If you have conda installed you might want to start from a fresh environment. This part is not installing psi-j but setting up a new environment with the specified python version:
14+
If you have conda installed you might want to start from a fresh environment. This part is not installing psij but setting up a new environment with the specified python version:
1515

16-
1. `conda create -n psi-j python=3.7`
17-
2. `conda activate psi-j`
16+
1. `conda create -n psij python=3.7`
17+
2. `conda activate psij`
1818

1919

20-
Install psi-j from the github repository:
20+
Install psij from the github repository:
2121

2222
1. Clone repository into your working directory:
2323

@@ -85,4 +85,4 @@ for i in range(N):
8585
2. In this example the number of jobs is 1. Set *N* to the number of jobs you want to run and save file.
8686

8787
3. `python my-workflow.py`
88-
88+

README-testing.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Setting up an automated testing job
2121

2222
This is the preferred way of running the tests since it allows the PSI/J
2323
team to keep a constant eye on the state of the library on various
24-
resources. To set up the Cron job (or an alternative method), you can either
24+
resources. To set up the Cron job (or an alternative method), you can either
2525
use the provided setup script:
2626

2727
```bash
@@ -30,13 +30,13 @@ use the provided setup script:
3030

3131
or manually set up the CI runner with Cron or your favorite scheduler.
3232

33-
Note: If you need to set up an environment module (such as
33+
Note: If you need to set up an environment module (such as
3434
`module load python/cpython-x.y.z`) or something similar, such as
3535
loading a conda or virtual environment, please add the relevant commands to
3636
`psij-ci-load`, which is sourced before tests are run by `psij-ci-run`. If the
37-
setup script is run under a venv or Conda, it will attempt to detect this and
38-
ask whether the relevant environment activation commands should be added to
39-
`psij-ci-load`. However, not all circumstances can be reliably detected and
37+
setup script is run under a venv or Conda, it will attempt to detect this and
38+
ask whether the relevant environment activation commands should be added to
39+
`psij-ci-load`. However, not all circumstances can be reliably detected and
4040
you may need to manually edit `psij-ci-load`.
4141

4242
Testing with the CI runner
@@ -69,7 +69,7 @@ Testing with pytest
6969
===================
7070

7171
This is the most direct way to run the tests and it must be done from the
72-
main psi-j directory. Use the following steps:
72+
main psij directory. Use the following steps:
7373

7474
1. Install dependencies:
7575
```bash

docs/development/contributing.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ How to Contribute
77

88
PSI/J welcomes all who wish to contribute, whether that means adding new features,
99
fixing typos, reporting/fixing bugs, or writing documentation. Use the
10-
`GitHub repo <https://github.com/ExaWorks/psi-j-python>`_
10+
`GitHub repo <https://github.com/ExaWorks/psij-python>`_
1111
to create issues and pull requests. Please follow the
12-
`contributing guide <https://github.com/ExaWorks/psi-j-python/blob/main/CONTRIBUTING.md>`_.
12+
`contributing guide <https://github.com/ExaWorks/psij-python/blob/main/CONTRIBUTING.md>`_.
1313

1414
Please note that many high-level design questions may be better discussed in
1515
the `PSI/J design repo <https://github.com/ExaWorks/job-api-spec>`_, rather than the Python library implementation
@@ -32,11 +32,11 @@ The testing dashboard website
3232
To record your test results to PSI/J's public testing dashboard,
3333
and to schedule the test suite to run automatically on a timer,
3434
see the
35-
`testing README <https://github.com/ExaWorks/psi-j-python/blob/main/README-testing.md>`_.
35+
`testing README <https://github.com/ExaWorks/psij-python/blob/main/README-testing.md>`_.
3636

3737

3838
Building the Documentation
3939
--------------------------
4040

4141
See the instructions in the
42-
`README <https://github.com/ExaWorks/psi-j-python/blob/main/README-dev.md>`_.
42+
`README <https://github.com/ExaWorks/psij-python/blob/main/README-dev.md>`_.

docs/development/programming.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,5 +175,5 @@ defined interface. This interface consists of:
175175
Writing a custom script based launcher can be as easy as subclassing
176176
:class:`~psij.launchers.script_based_launcher.ScriptBasedLauncher` and passing
177177
a launcher script path to the base class constructor. For example, see the
178-
`MPI launcher class <https://github.com/ExaWorks/psi-j-python/blob/main/src/psij/launchers/mpirun.py>` and the
179-
`MPI launcher script <https://github.com/ExaWorks/psi-j-python/blob/main/src/psij/launchers/scripts/mpi_launch.sh>`.
178+
`MPI launcher class <https://github.com/ExaWorks/psij-python/blob/main/src/psij/launchers/mpirun.py>` and the
179+
`MPI launcher script <https://github.com/ExaWorks/psij-python/blob/main/src/psij/launchers/scripts/mpi_launch.sh>`.

docs/getting_started.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ Install from pip
1919

2020
.. code-block:: console
2121
22-
pip install psi-j
22+
pip install psij
2323
2424
Install from source
2525
^^^^^^^^^^^^^^^^^^^
2626

2727
.. code-block:: console
2828
29-
git clone https://github.com/ExaWorks/psi-j-python.git
30-
cd psi-j-python
29+
git clone https://github.com/ExaWorks/psij-python.git
30+
cd psij-python
3131
pip install .
3232
3333
@@ -290,7 +290,7 @@ Examples
290290
--------
291291

292292
Up-to-date and actively tested examples can be found
293-
`here <https://github.com/ExaWorks/psi-j-python/blob/main/tests/test_doc_examples.py>`_.
293+
`here <https://github.com/ExaWorks/psij-python/blob/main/tests/test_doc_examples.py>`_.
294294
Tests of resource-manager-specific and site-specific values
295295
(such as accounts, queues/partitions, etc.) can be found in files
296296
in the same directory but tend to buried under

0 commit comments

Comments
 (0)