NCRC-client

NCRC-client

This is a simple wrapper script that will be used to enable the use of a two-factor authentication mechanism for downloading NCRC controlled codes through the popular "Conda" distribution mechanism.

Other Software

Idaho National Laboratory is a cutting edge research facility which is constantly producing high quality research and software. Feel free to take a look at our other software and scientific offerings at:

Primary Technology Offerings Page

Supported Open Source Software

Raw Experiment Open Source Software

Unsupported Open Source Software

License

Copyright 2021 Battelle Energy Alliance, LLC

Licensed under the BSD 3-clause (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://opensource.org/licenses/BSD-3-Clause - LINK TO OSI FOR LICENSE 3-Clause BSD

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensing

This software is licensed under the terms you may find in the file named "LICENSE" in this directory.

Developers

By contributing to this software project, you are agreeing to the following terms and conditions for your contributions:

You agree your contributions are submitted under the BSD 3-Clause license. You represent you are authorized to make the contributions and grant the license. If your employer has rights to intellectual property that includes your contributions, you represent that you have received permission to make contributions and grant the required license on behalf of that employer.

NCRC Client

The NCRC client allows users to search for, and install NCRC applications protected behind an RSA credential challenge. The NCRC client itself is open source, and available publicly.

NCRC Client Installation

$> conda install ncrc --channel https://conda.software.inl.gov/public

Install an NCRC Application

With the NCRC client installed, you can now use it to install an NCRC Application.

Important

You will first need to be granted access to the applicable application. To do so, head on over to https://inl.gov/ncrc/ to request access.

$> ncrc install bison
Username: johndoe
PIN+TOKEN:
Solving requirements for bison...

Once finished, follow the on-screen instructions:

$> conda activate bison
$> bison-opt --version
<version is displayed>

Note

The first time you run the application, the application may appear to hang. Consecutive runs will not be hindered.

NCRC Syntax

usage: ncrc [-h] {install,remove,search,list} ...

Manage NCRC packages

positional arguments:
  {install,remove,search,list}
                        Available Commands.
    install             Install application
    remove              Prints information on how to remove application
    search              Perform a regular expression search for an NCRC
                        application
    list                List all available NCRC applications

optional arguments:
  -h, --help            show this help message and exit

NCRC Examples Usages

List all available NCRC applications:

$> ncrc list
# Use 'ncrc search name-of-application' to list more detail
# NCRC applications available:

	sockeye
	direwolf
	griffin
	pronghorn
	relap7
	bison
	bluecrab
	marmot
	sabertooth

Lists all available versions of griffin:

$> ncrc search griffin
Loading channels: done
# Name                       Version           Build  Channel
... <trimmed>
ncrc-griffin              2024_09_30         build_0  ncrc-applications
ncrc-griffin              2024_10_11         build_0  ncrc-applications

Note: Only the last 90 days worth of packages are available. Older
      packages can be made available upon request.
      https://mooseframework.inl.gov/help/inl/applications.html

Installing a specific version:

$> ncrc install griffin=2024_09_30
Username: johndoe
PIN+TOKEN:
Solving requirements for griffin...
Downloading ncrc-griffin-2024_10_11-build_0.tar.bz2...

# after installation completes
$> conda activate griffin
$> griffin-opt --version
<the version is displayed>

Removing an application:

$> ncrc remove bison
 Due to the way ncrc wraps itself into conda commands, it is best to
 remove the environment in which the application is installed. Begin
 by deactivating the application environment and then remove it:
	conda deactivate
	conda env remove -n bison

Note

The NCRC script being a wrapper tool, is unable to perform such a function. The user must deactivate the environment and remove that environment using the appropraite conda commands.

Troubleshooting

The occasional download failure is usually a victim of circumstance. Where the only solution is to "try again". If the issue persists, check with our Discussions group for any known outages: idaholab/moose#28494. If there are none, feel free to create a new discusion to report any failures.

If you receive invalid credentials, you'll want to head on over to the NCRC page for contacting help: https://inl.gov/ncrc/ (Make/Manage Requests, contact information will be listed on the left).

If you are running into a command not found error, chances are, you not operating within the Conda environment for which you installed the NCRC client. Be sure you installed the client into your (base) environment, or that you are in the (base) environment while attempting to invoke ncrc:

$> conda activate base
$> ncrc --help