Merge pull request #300 from ExaWorks/update_repo_refs

Updated name/references to `psij-python` from `psi-j-python`.

Author: hategan

QuickStart.md

@@ -3,27 +3,27 @@
 This document will guide you through the install procedure and your first hello world example.
 
 - [Requirements](#requirements)
-- [Install psi-j](#install-psi-j)
+- [Install psij](#install-psij)
 - [Hello World example](#hello-world)
 
 ## Requirements
 - python3.7+
 
-## Install psi-j
+## Install psij
 
-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:
+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:
 
-1. `conda create -n psi-j python=3.7`
-2. `conda activate psi-j`
+1. `conda create -n psij python=3.7`
+2. `conda activate psij`
 
 
-Install psi-j from the github repository:
+Install psij from the github repository:
 
 1. Clone repository into your working directory:
 
-    `git clone https://github.com/ExaWorks/psi-j-python.git`
+    `git clone https://github.com/ExaWorks/psij-python.git`
 
-2. `cd psi-j-python`
+2. `cd psij-python`
 3. `pip install .`
 
 
@@ -85,4 +85,4 @@ for i in range(N):
 2. In this example the number of jobs is 1. Set *N* to the number of jobs you want to run and save file.
 
 3. `python my-workflow.py`
- 
+

README-testing.md

@@ -21,7 +21,7 @@ Setting up an automated testing job
 
 This is the preferred way of running the tests since it allows the PSI/J
 team to keep a constant eye on the state of the library on various
-resources. To set up the Cron job (or an alternative method), you can either 
+resources. To set up the Cron job (or an alternative method), you can either
 use the provided setup script:
 
 ```bash
@@ -67,7 +67,7 @@ Testing with pytest
 ===================
 
 This is the most direct way to run the tests and it must be done from the
-main psi-j directory. Use the following steps:
+main psij directory. Use the following steps:
 
 1. Install dependencies:
 ```bash

README.md

@@ -2,7 +2,14 @@
 
 # Portable Submission Interface for Jobs
 
-PSI/J is an abstraction layer over cluster schedulers to write scheduler agnostic HPC applications. PSI/J automatically translates abstract job specifications into concrete scripts and commands to send to the scheduler. PSI/J is tested on a wide variety of clusters. For further information about [PSI/J](https://exaworks.org/job-api-spec/) or the [SDK](https://github.com/ExaWorks/SDK) visit the [ExaWorks](https://exaworks.org/) project page and read the [PSI/J documentation](https://exaworks.org/psi-j-python/#docs).
+PSI/J is an abstraction layer over cluster schedulers to write scheduler
+agnostic HPC applications. PSI/J automatically translates abstract job
+specifications into concrete scripts and commands to send to the
+scheduler. PSI/J is tested on a wide variety of clusters. For further
+information about [PSI/J](https://exaworks.org/job-api-spec/) or the
+[SDK](https://github.com/ExaWorks/SDK) visit the
+[ExaWorks](https://exaworks.org/) project page and read the [PSI/J
+documentation](https://exaworks.org/psij-python/#docs).
 
 
 ## Introduction

docs/development/contributing.rst

@@ -7,9 +7,9 @@ How to Contribute
 
 PSI/J welcomes all who wish to contribute, whether that means adding new features,
 fixing typos, reporting/fixing bugs, or writing documentation. Use the
-`GitHub repo <https://github.com/ExaWorks/psi-j-python>`_
+`GitHub repo <https://github.com/ExaWorks/psij-python>`_
 to create issues and pull requests. Please follow the
-`contributing guide <https://github.com/ExaWorks/psi-j-python/blob/main/CONTRIBUTING.md>`_.
+`contributing guide <https://github.com/ExaWorks/psij-python/blob/main/CONTRIBUTING.md>`_.
 
 Please note that many high-level design questions may be better discussed in
 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
 To record your test results to PSI/J's public testing dashboard,
 and to schedule the test suite to run automatically on a timer,
 see the
-`testing README <https://github.com/ExaWorks/psi-j-python/blob/main/README-testing.md>`_.
+`testing README <https://github.com/ExaWorks/psij-python/blob/main/README-testing.md>`_.
 
 
 Building the Documentation
 --------------------------
 
 See the instructions in the
-`README <https://github.com/ExaWorks/psi-j-python/blob/main/README-dev.md>`_.
+`README <https://github.com/ExaWorks/psij-python/blob/main/README-dev.md>`_.

docs/development/programming.rst

@@ -175,5 +175,5 @@ defined interface. This interface consists of:
 Writing a custom script based launcher can be as easy as subclassing
 :class:`~psij.launchers.script_based_launcher.ScriptBasedLauncher` and passing
 a launcher script path to the base class constructor. For example, see the
-`MPI launcher class <https://github.com/ExaWorks/psi-j-python/blob/main/src/psij/launchers/mpirun.py>` and the
-`MPI launcher script <https://github.com/ExaWorks/psi-j-python/blob/main/src/psij/launchers/scripts/mpi_launch.sh>`.
+`MPI launcher class <https://github.com/ExaWorks/psij-python/blob/main/src/psij/launchers/mpirun.py>` and the
+`MPI launcher script <https://github.com/ExaWorks/psij-python/blob/main/src/psij/launchers/scripts/mpi_launch.sh>`.

docs/getting_started.rst

@@ -19,15 +19,15 @@ Install from pip
 
 .. code-block:: console
 
-    pip install  psi-j
+    pip install psij
 
 Install from source
 ^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: console
 
-    git clone https://github.com/ExaWorks/psi-j-python.git
-    cd psi-j-python
+    git clone https://github.com/ExaWorks/psij-python.git
+    cd psij-python
     pip install .
 
 
@@ -290,7 +290,7 @@ Examples
 --------
 
 Up-to-date and actively tested examples can be found
-`here <https://github.com/ExaWorks/psi-j-python/blob/main/tests/test_doc_examples.py>`_.
+`here <https://github.com/ExaWorks/psij-python/blob/main/tests/test_doc_examples.py>`_.
 Tests of resource-manager-specific and site-specific values
 (such as accounts, queues/partitions, etc.) can be found in files
 in the same directory but tend to buried under

psij-ci-run

@@ -52,7 +52,7 @@ else
 fi
 
 # Ensure latest test runner is there
-git fetch https://github.com/ExaWorks/psi-j-python.git
+git fetch https://github.com/ExaWorks/psij-python.git
 git checkout FETCH_HEAD -- tests/ci_runner.py
 
 

scripts/WORKFLOW-EXAMPLES.md

@@ -163,7 +163,7 @@ for j in [make_job(pdf2textSingularitySpec, None), make_job(text2wordcloudSingul
 
 ## Executing an MPI job
 
-In this example we demonstrate how to wrap and execute an mpi hello world job with PSI/J. The base mpi command is `mpiexec -n 36 -ppn 36 echo Hello world`. This example is introducing the concept of a [job launcher](https://exaworks.org/psi-j-python/docs/programming.html#launchers), in this case **mpi**, e.g. `job.spec.launcher = "mpirun"`. The complete example script can be found [here](./).
+In this example we demonstrate how to wrap and execute an mpi hello world job with PSI/J. The base mpi command is `mpiexec -n 36 -ppn 36 echo Hello world`. This example is introducing the concept of a [job launcher](https://exaworks.org/psij-python/docs/programming.html#launchers), in this case **mpi**, e.g. `job.spec.launcher = "mpirun"`. The complete example script can be found [here](./).
 
 1. Load psij module and instanciate job executer, e.g. local or slurm
 

setup.py

@@ -9,16 +9,16 @@
         install_requires = f.readlines()
 
     setup(
-        name='psi-j-python',
+        name='psij-python',
         version=VERSION,
 
-        description='''This is an implementation of the J/PSI (Portable Submission Interface for Jobs)
+        description='''This is an implementation of the PSI/J (Portable Submission Interface for Jobs)
         specification.''',
 
         author='The ExaWorks Team',
         author_email='[email protected]',
 
-        url='https://github.com/exaworks/psi-j-python',
+        url='https://github.com/exaworks/psij-python',
 
         classifiers=[
             'Programming Language :: Python :: 3',

testing.conf

@@ -174,4 +174,4 @@ max_age = 48
 # and to retrieve the list of PRs and their comments.
 #
 
-repository = ExaWorks/psi-j-python
+repository = ExaWorks/psij-python