Skip to content

Commit

Permalink
Update links for new ownership (#446)
Browse files Browse the repository at this point in the history
* Update links for new owner

* Update index.rst

* Update developer_workflow.md

* Update developer_spack_minimum.md

* Update CONTRIBUTING.md

* Update useful_commands.md

* Update snapshot_workflow.md
  • Loading branch information
psakievich authored Nov 29, 2022
1 parent 365c80d commit 34de245
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Thank you for your interest in contributing to the project. Please adhere to to
## Issues

Please feel free to make issues for any questions you have. Github issues help us stay organized and are a valuable mechanism for archiving information.
We do ask that you review our [FAQ](https://psakievich.github.io/spack-manager/general/FAQ.html) before submitting a ticket.
We do ask that you review our [FAQ](https://sandialabs.github.io/spack-manager/general/FAQ.html) before submitting a ticket.
We try to archive the most common user issues there so it will likely save you (and us) some time.

## Pull Requests
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Spack-Manager

[Documentation](https://psakievich.github.io/spack-manager) | [![Test Status](https://github.com/psakievich/spack-manager/workflows/Spack-Manager%20Tests/badge.svg)](https://github.com/psakievich/spack-manager/actions)
[Documentation](https://sandialabs.github.io/spack-manager) | [![Test Status](https://github.com/sandialabs/spack-manager/workflows/Spack-Manager%20Tests/badge.svg)](https://github.com/psakievich/spack-manager/actions)

Spack-Manager is a light-weight extension to Spack that is intended to streamline the software development and deployment cycle for individual software projects on specific machines. Currently this project focused on serving the needs of the [ExaWind project](https://github.com/ExaWind), but is designed and intended to serve multiple projects simultaneously in the future.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
===============


`Spack-Manager <https://github.com/psakievich/spack-manager>`_ is a light-weight extension to
`Spack-Manager <https://github.com/sandialabs/spack-manager>`_ is a light-weight extension to
`Spack <https://github.com/spack/spack>`_ that is intended to streamline the software development and deployment cycle
for individual software projects on specific machines.

Expand Down
4 changes: 2 additions & 2 deletions docs/user_profiles/developers/developer_spack_minimum.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ For this section it is sufficient to know that `spack info` is the key to knowin
Spack specs are critical to using Spack-Manager because they are the language used to communicate the options and configurations of
the software that is getting built.
We provide an overview of what a spec is, and the parts that go into making a Spack spec in our
[general documentation](https://psakievich.github.io/spack-manager/general/spack_features.html#spack-specs),
[general documentation](https://sandialabs.github.io/spack-manager/general/spack_features.html#spack-specs),
and an even more thorough description can be found in the
[spack documentation](https://spack.readthedocs.io/en/latest/basic_usage.html#specs-dependencies)

Expand Down Expand Up @@ -183,7 +183,7 @@ The major steps and associated commands for building software with Spack environ
Now that you've decided what combination of software you want to build, what elements you want to develop, and what the dependency graph is all that is left is to build and install. Easy right?

This may seem like a lot to go over, and this was not a very thorough description of each step.
These steps are covered with a workflow example in the [developer tutorial](https://psakievich.github.io/spack-manager/user_profiles/developers/developer_workflow.html)
These steps are covered with a workflow example in the [developer tutorial](https://sandialabs.github.io/spack-manager/user_profiles/developers/developer_workflow.html)
where we walk through each step one at a time.
The intention of this page is to serve as an introduction and a reference going forward.
If you forget a step or command you can always come back to this page to see what it is and see a brief description of the whole process.
Expand Down
12 changes: 6 additions & 6 deletions docs/user_profiles/developers/developer_workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The ideal location for this directory is one that has adequate storage for multi
and it should also be on a filesytem that is accesible where you plan to run the software.

```console
git clone --recursive [email protected]:psakievich/spack-manager.git
git clone --recursive [email protected]:sandialabs/spack-manager.git
```
In order for Spack-Manager to work you need to define the `SPACK_MANAGER` environment variable,
and it should provide the absolute path to your Spack-Manager directory. To have access to the
Expand All @@ -38,7 +38,7 @@ source $SPACK_MANAGER/start.sh
## Creating an Environment

With the Spack development workflow we are going to create an environment similar to a Conda environment.
Setting up the environments is a multistep process that is outlined in greater detail [here](https://psakievich.github.io/spack-manager/user_profiles/developers/snapshot_workflow.html) and [here](https://psakievich.github.io/spack-manager/user_profiles/developers/useful_commands.html#environment-setup-process).
Setting up the environments is a multistep process that is outlined in greater detail [here](https://sandialabs.github.io/spack-manager/user_profiles/developers/snapshot_workflow.html) and [here](https://sandialabs.github.io/spack-manager/user_profiles/developers/useful_commands.html#environment-setup-process).
There are three `quick-commands` for creating environments: `quick-create`, `quick-create-dev` and `quick-develop`.
They all exit the process of setting up an environment at different points in the process as outlined below:

Expand Down Expand Up @@ -98,7 +98,7 @@ quick-create-dev -n example-env -s exawind@master nalu-wind@master amr-wind@main
If you don't want to develop one of these packages (say you're only focused on `amr-wind`) then just ommit the software you don't
plan to develop in from the spec list in the command above. Please note that these specs need to be concrete specs, meaning they have the name
(`amr-wind`) and the version from spack (`main`), and that **that the version is not necessarily the same thing as the branch**.
This is covered in the [things developers need to know about Spack](https://psakievich.github.io/spack-manager/user_profiles/developers/developer_spack_minimum.html) for those needing a refresher.
This is covered in the [things developers need to know about Spack](https://sandialabs.github.io/spack-manager/user_profiles/developers/developer_spack_minimum.html) for those needing a refresher.

The `-n` flag can be replaced with `-d` if we want to setup an environment in a different location than `$SPACK_MANAGER/environments` (see the help message above).
The `quick-create-dev` command will execute all the stages in the table above including cloning the repos from github for the software.
Expand Down Expand Up @@ -154,9 +154,9 @@ In this environment if you make a change in `amr-wind` it will also trigger a re
## Running Tests and Coming Back

To run tests in a one off manner you can use the `spack build-env` command to run commands in a sub-shell with the build environment.
This is further documented [here](https://psakievich.github.io/spack-manager/user_profiles/developers/snapshot_workflow.html#running).
This is further documented [here](https://sandialabs.github.io/spack-manager/user_profiles/developers/snapshot_workflow.html#running).
We also have a function `build-env-dive` which is a beta feature that launches this same subshell in your terminal and dives into it.
It is further documented [here](https://psakievich.github.io/spack-manager/user_profiles/developers/useful_commands.html#build-env-dive).
It is further documented [here](https://sandialabs.github.io/spack-manager/user_profiles/developers/useful_commands.html#build-env-dive).

If you wish to come back to an environment later, or in a new shell you can just run
```console
Expand All @@ -170,7 +170,7 @@ These are the commands needed to set up Spack-Manager and a development build fo

```console
# setup Spack-Manager
git clone --recursive [email protected]:psakievich/spack-manager.git
git clone --recursive [email protected]:sandialabs/spack-manager.git
export SPACK_MANAGER=$(pwd)/spack-manager
source $SPACK_MANAGER/start.sh
# setup environment
Expand Down
2 changes: 1 addition & 1 deletion docs/user_profiles/developers/snapshot_workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ projects for running on the GPU using CUDA. Starting from nothing, we first clon
```
[user@el1 ~]$ export SCRATCH=/scratch/${USER}
[user@el1 ~]$ cd ${SCRATCH}
[user@el1 user]$ git clone --recursive https://github.com/psakievich/spack-manager.git
[user@el1 user]$ git clone --recursive https://github.com/sandialabs/spack-manager.git
Cloning into 'spack-manager'...
remote: Enumerating objects: 2610, done.
remote: Counting objects: 100% (2610/2610), done.
Expand Down
4 changes: 2 additions & 2 deletions docs/user_profiles/developers/useful_commands.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Useful Commands for Development

In the [developer tutorial](https://psakievich.github.io/spack-manager/user_profiles/developers/developer_tutorial.html) the granular Spack commands are shown to help youe become familiar with the process of building with Spack.
In the [developer tutorial](https://sandialabs.github.io/spack-manager/user_profiles/developers/developer_tutorial.html) the granular Spack commands are shown to help youe become familiar with the process of building with Spack.
Using these commands (along with familiarization with the [spack.yaml](https://spack.readthedocs.io/en/latest/environments.html#spack-yaml)) will allow you to create a fully customized build environments.

In practice many of these commands are redundant and unneccesary for standard development workflows.
Expand Down Expand Up @@ -114,4 +114,4 @@ In practice this has not been much of an issue.
(#remove-spack-prompt)=
### remove-spack-prompt
This command takes no arguments unless you pass `-h` or `--help`.
It simply removes the prompt with the environment name that the _quick-commands_ add.
It simply removes the prompt with the environment name that the _quick-commands_ add.

0 comments on commit 34de245

Please sign in to comment.