Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#1193 assetize outputs #1219

Merged
merged 117 commits into from
Oct 20, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
117 commits
Select commit Hold shift + click to select a range
fcf0d2a
Skeleton
devclinton Oct 3, 2020
84b69bc
Merge branch '1158_pass_platform' of github.com:InstituteforDiseaseMo…
devclinton Oct 3, 2020
f6d5d45
#1193 - Add tests for pre_create hooks
devclinton Oct 4, 2020
559a23a
Default to list
devclinton Oct 4, 2020
c1b01a5
MOre tests
devclinton Oct 4, 2020
2e4eb6e
Initial Working version
devclinton Oct 4, 2020
ebd1776
Add progress bar to scan
devclinton Oct 4, 2020
2b4b6fd
Add a new set of APIs to Experiment, Suite, and WorkItems as runnable…
devclinton Oct 5, 2020
fd1fc74
Refactor smmt script to add more features and clarify code
devclinton Oct 5, 2020
344130a
Improve IRunnableEntity
devclinton Oct 5, 2020
2ce59ee
Add checks before running in SSMT for status of items
devclinton Oct 5, 2020
d680417
Fix bug where all sims could have been filtered, so assets would be i…
devclinton Oct 5, 2020
714effb
Suite object
devclinton Oct 5, 2020
3af9460
Fix linting
devclinton Oct 5, 2020
3a1a44c
Fix linting
devclinton Oct 5, 2020
a4ee370
Fix linting
devclinton Oct 5, 2020
8de6a6f
Fix linting
devclinton Oct 5, 2020
374b148
Add test from id
devclinton Oct 8, 2020
0bf4b59
Add test from id
devclinton Oct 8, 2020
8f15721
Return AC
devclinton Oct 8, 2020
f5d458d
Return AC from run
devclinton Oct 8, 2020
efab899
Start error handler
devclinton Oct 8, 2020
87f0854
Add test of simulation
devclinton Oct 8, 2020
efa011a
Add test of format
devclinton Oct 8, 2020
e56bdb1
test workfitem prefix
devclinton Oct 8, 2020
bfb9fed
test workfitem prefix
devclinton Oct 8, 2020
b326aa8
Add dry run
devclinton Oct 8, 2020
2145005
Use glob matching on include/exclude
devclinton Oct 8, 2020
867ef7a
Merge branch 'dev' of github.com:InstituteforDiseaseModeling/idmtools…
devclinton Oct 9, 2020
b47871a
Fix test so that is doesn't filter out txt files
devclinton Oct 9, 2020
5f5ddf2
Fix test so that is doesn't filter out txt files
devclinton Oct 9, 2020
d1e7709
Fix test so that is doesn't filter out txt files
devclinton Oct 9, 2020
a6fc0c0
Fix race condition with high thread counts
devclinton Oct 9, 2020
d388184
Add extra logging for command issues
devclinton Oct 10, 2020
d536318
#1220
devclinton Oct 10, 2020
f379372
Linting
devclinton Oct 10, 2020
02022ca
#1224 Supporting creating asset collections from list of files
devclinton Oct 10, 2020
5d90e05
Fix bug in asset when None passed
devclinton Oct 10, 2020
dfa3696
Fix Analysis
devclinton Oct 10, 2020
9744bbf
Replace common files
devclinton Oct 10, 2020
e402b8b
Fix asset collection
devclinton Oct 10, 2020
ee4a0e9
fetch asset collection id
devclinton Oct 10, 2020
fd81268
Switch back to main
devclinton Oct 10, 2020
c253283
Switch back to main
devclinton Oct 10, 2020
5fbd953
Change to assets
devclinton Oct 10, 2020
8b26846
Mark problematic test as serial for comps
devclinton Oct 10, 2020
1d3eb88
3.8.5
devclinton Oct 10, 2020
e1a9bf2
Set ID for test
devclinton Oct 10, 2020
0fcd403
Mark directories that change directories to serial
devclinton Oct 10, 2020
831492b
Add examples and docs for assetize
devclinton Oct 14, 2020
e7c14b2
Merge branch 'dev' of github.com:InstituteforDiseaseModeling/idmtools…
devclinton Oct 14, 2020
79628c2
Fix name
devclinton Oct 14, 2020
33b4215
In cases where executable is None
devclinton Oct 14, 2020
7cf7392
Prune tests from packages
devclinton Oct 14, 2020
bafffd9
Update JSON task/Python task with new command rules
devclinton Oct 14, 2020
af2613f
Clearer code
devclinton Oct 14, 2020
b0f8c98
Add from_string method to allow parsing commands from string easier
devclinton Oct 15, 2020
3afee00
Update other references to use from_string
devclinton Oct 15, 2020
073677c
Linting fix
devclinton Oct 15, 2020
e0492b8
Improve command line
devclinton Oct 15, 2020
cbbd829
Fix window pathing in Template
devclinton Oct 15, 2020
11f8b26
Don't use join from shlex since it is new to 3.8
devclinton Oct 15, 2020
b61a2e8
Support command line from string in init for backwards compatibility
devclinton Oct 15, 2020
7ab62f1
Update R Task/Python + tests for rendering in pre_creation
devclinton Oct 15, 2020
f4b6f8e
Change order of precreation
devclinton Oct 15, 2020
4557f8f
Quote windows command properly
devclinton Oct 15, 2020
1a4f4d7
#1232 - Add a function to deteremine if target platform is Windows
devclinton Oct 15, 2020
c0fc1a9
Fix CLI test
devclinton Oct 15, 2020
71febf2
Fix bug in command task not calling super pre_creation
devclinton Oct 15, 2020
b074e60
Ensure item is loaded ignored cache
devclinton Oct 15, 2020
41fd693
Fix cli through logging setup
devclinton Oct 15, 2020
bc3bb00
Ensure all platformfactory is serial
devclinton Oct 15, 2020
90becea
Increase timeout for tests
devclinton Oct 15, 2020
66a8d12
Increase timeout for tests
devclinton Oct 15, 2020
437dfbb
Shard cache for threading
devclinton Oct 15, 2020
b69492a
Retry after certain cache errors
devclinton Oct 15, 2020
1bbfa7c
AnalyzerManager test do better in serial
devclinton Oct 15, 2020
5ea960b
Fix commands
devclinton Oct 15, 2020
8ba95a5
Fix reload of python tasks
devclinton Oct 15, 2020
52d412c
Add tag, prefixes, and name to command line
devclinton Oct 15, 2020
dfe38bf
Add link to AC in CLI output
devclinton Oct 15, 2020
1c051f8
Linting
devclinton Oct 15, 2020
2d2842b
Don't output name if in json mode
devclinton Oct 15, 2020
411fc33
Fix json to default to false
devclinton Oct 15, 2020
46f2941
Support converting ItemTypes to strings
devclinton Oct 15, 2020
78cc7eb
Fix workitem environment check
devclinton Oct 15, 2020
c52fc5d
Fix item
devclinton Oct 15, 2020
de05184
Allow passing of platform
devclinton Oct 15, 2020
a2acf46
Fix bug on get_platform on assetize_output.py
devclinton Oct 15, 2020
29a19d3
Fix examples
devclinton Oct 15, 2020
c11f9ca
Cleanup example
devclinton Oct 15, 2020
3a02f0b
Make testing more parallel with more overhead for setup
devclinton Oct 16, 2020
3beb6bb
Fix file
devclinton Oct 16, 2020
7485920
Fix release and labels
devclinton Oct 16, 2020
c54a062
Fix item
devclinton Oct 16, 2020
8ed39bd
Remove arch since it default to x64
devclinton Oct 16, 2020
749c4d4
Try semvers
devclinton Oct 16, 2020
90c31a5
Fix path detection for comps/local
devclinton Oct 16, 2020
4ceff3f
Fix names and run no-docker setup on main item
devclinton Oct 16, 2020
ec5749c
Update rules
devclinton Oct 16, 2020
3bb9bb7
Set global test timeout
devclinton Oct 16, 2020
6fd6e27
Add new error for no items
devclinton Oct 17, 2020
b88c281
Fix docs
devclinton Oct 17, 2020
7d11838
Fix edge case when running in lots of threads
devclinton Oct 17, 2020
fa247c9
Mark test as serial
devclinton Oct 17, 2020
005fa64
Set timeout to 10minutes
devclinton Oct 17, 2020
986b8fe
Update test
devclinton Oct 17, 2020
5391b90
#1244 - Fallback to console if the file cannot be opened
devclinton Oct 17, 2020
e300e9c
Fix logging
devclinton Oct 17, 2020
852af50
logging
devclinton Oct 17, 2020
87be3b1
Fix test
devclinton Oct 19, 2020
5146795
Fix warning on comps work items so task is created first
devclinton Oct 19, 2020
b8e7a57
Update help
devclinton Oct 19, 2020
c62601f
Detect duplicate assets and provide a list back to the user
devclinton Oct 20, 2020
d94c980
Workorder.json for default command
devclinton Oct 20, 2020
e03a81f
Fix assetize output duplicate validation
devclinton Oct 20, 2020
ef5d038
Fix assetize duplicate detection
devclinton Oct 20, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
252 changes: 223 additions & 29 deletions .github/workflows/pr-all-test-ubuntu-setup.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ name: "pr-all-test-ubuntu-setup"
on: [pull_request]

jobs:
pr-run-all-test-ubuntu-setup:
pr-test-core-linux:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [self-hosted]
python-version: [3.6.12, 3.7.5, 3.8.2]
os: [self-linux]
python-version: ['3.6.x', '3.7.x', '3.8.x']
steps:
- name: Check out Git repository
uses: actions/checkout@v2
Expand All @@ -26,28 +26,87 @@ jobs:
models:
- 'idmtools_models/**'
comps:
- 'idmtools_comps_platform/**'
- 'idmtools_platform_comps/**'
local:
- 'idmtools_local_platform/**'
- 'idmtools_platform_local/**'
- uses: actions/cache@v2
if: steps.filter.outputs.core == 'true'
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}-${{ hashFiles('**/*_requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- name: ${{ matrix.os }} Python ${{ matrix.python-version }}
uses: MaksimZhukov/setup-python@main
if: steps.filter.outputs.core == 'true'
uses: actions/setup-python@v2.1.4
with:
python-version: ${{ matrix.python-version }}
architecture: x64
- name: Install Python dependencies
if: steps.filter.outputs.core == 'true'
run: |
pip install idm-buildtools flake8 wheel --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple
- name: Run setup-dev
# only run if full install for core, local changes, or models
if: steps.filter.outputs.core == 'true' || steps.filter.outputs.local == 'true' || steps.filter.outputs.models == 'true'
run: |
make setup-dev
- name: Run setup-dev
- name: Run setup-dev-no-docker
# only run if core, local, models wasn't changed
if: steps.filter.outputs.core == 'false' && steps.filter.outputs.local == 'false' && steps.filter.outputs.models == 'false'
if: steps.filter.outputs.core == 'true'
run: |
make setup-dev-no-docker
- name: login to comps2
if: steps.filter.outputs.core == 'true'
run: |
python dev_scripts/create_auth_token_args.py --username $COMPS_USER --password $COMPS_PASSWORD
- name: run idmtools_core smoke tests
# only run if core changed
if: steps.filter.outputs.core == 'true'
run: |
cd idmtools_core
make test-all
- name: Upload idmtools_core smoke test results
uses: actions/upload-artifact@v2
if: failure() && steps.filter.outputs.core == 'true'
with:
name: idmtools_core_test_results
path: idmtools_core/tests/reports/
pr-test-cli-linux:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ self-linux ]
python-version: [ 3.6.12, 3.7.9, 3.8.6 ]
steps:
- name: Check out Git repository
uses: actions/checkout@v2
- uses: dorny/paths-filter@v2
id: filter
with:
base: dev
filters: |
core:
- 'idmtools_core/**'
cli:
- 'idmtools_cli/**'
- uses: actions/cache@v2
if: steps.filter.outputs.core == 'true' || steps.filter.outputs.cli == 'true'
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}-${{ hashFiles('**/*_requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- name: ${{ matrix.os }} Python ${{ matrix.python-version }}
if: steps.filter.outputs.core == 'true' || steps.filter.outputs.cli == 'true'
uses: actions/setup-python@v2.1.4
with:
python-version: ${{ matrix.python-version }}
architecture: x64
- name: Install Python dependencies
if: steps.filter.outputs.core == 'true' || steps.filter.outputs.cli == 'true'
run: |
pip install idm-buildtools flake8 wheel --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple
- name: Run setup-dev-no-docker
if: steps.filter.outputs.core == 'true' || steps.filter.outputs.cli == 'true'
run: |
make setup-dev-no-docker
- name: login to comps2
if: steps.filter.outputs.core == 'true' || steps.filter.outputs.cli == 'true'
run: |
python dev_scripts/create_auth_token_args.py --username $COMPS_USER --password $COMPS_PASSWORD
- name: run idmtools_cli smoke tests
Expand All @@ -61,19 +120,56 @@ jobs:
if: failure() && (steps.filter.outputs.core == 'true' || steps.filter.outputs.cli == 'true')
with:
name: idmtools_cli_test_results
path: idmtools_cli/tests/test_results.xml
- name: run idmtools_core smoke tests
# only run if core changed
if: steps.filter.outputs.core == 'true'
run: |
cd idmtools_core
make test-all
- name: Upload idmtools_core smoke test results
uses: actions/upload-artifact@v2
if: failure() && steps.filter.outputs.core == 'true'
path: idmtools_cli/tests/reports/
pr-test-models-linux:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ self-linux ]
python-version: [ 3.6.12, 3.7.9, 3.8.6 ]
steps:
- name: Check out Git repository
uses: actions/checkout@v2
- uses: dorny/paths-filter@v2
id: filter
with:
name: idmtools_core_test_results
path: idmtools_core/tests/test_results.xml
base: dev
filters: |
core:
- 'idmtools_core/**'
cli:
- 'idmtools_cli/**'
models:
- 'idmtools_models/**'
comps:
- 'idmtools_platform_comps/**'
local:
- 'idmtools_platform_local/**'
- uses: actions/cache@v2
if: steps.filter.outputs.core == 'true' || steps.filter.outputs.models == 'true'
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}-${{ hashFiles('**/*_requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- name: ${{ matrix.os }} Python ${{ matrix.python-version }}
uses: actions/setup-python@v2.1.4
if: steps.filter.outputs.core == 'true' || steps.filter.outputs.models == 'true'
with:
python-version: ${{ matrix.python-version }}
architecture: x64
- name: Install Python dependencies
if: steps.filter.outputs.core == 'true' || steps.filter.outputs.models == 'true'
run: |
pip install idm-buildtools flake8 wheel --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple
- name: Run setup-dev-no-docker
if: steps.filter.outputs.core == 'true' || steps.filter.outputs.models == 'true'
run: |
make setup-dev-no-docker
- name: login to comps2
if: steps.filter.outputs.core == 'true' || steps.filter.outputs.models == 'true'
run: |
python dev_scripts/create_auth_token_args.py --username $COMPS_USER --password $COMPS_PASSWORD
- name: run idmtools_models tests
# only run if core changed
if: steps.filter.outputs.core == 'true' || steps.filter.outputs.models == 'true'
Expand All @@ -85,7 +181,55 @@ jobs:
if: failure() && (steps.filter.outputs.core == 'true' || steps.filter.outputs.models == 'true')
with:
name: idmtools_models_test_results
path: idmtools_models/tests/test_results.xml
path: idmtools_models/tests/results/
pr-test-comps-linux:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ self-linux ]
python-version: [ 3.6.12, 3.7.9, 3.8.6 ]
steps:
- name: Check out Git repository
uses: actions/checkout@v2
- uses: dorny/paths-filter@v2
id: filter
with:
base: dev
filters: |
core:
- 'idmtools_core/**'
cli:
- 'idmtools_cli/**'
models:
- 'idmtools_models/**'
comps:
- 'idmtools_platform_comps/**'
local:
- 'idmtools_platform_local/**'
- uses: actions/cache@v2
if: steps.filter.outputs.core == 'true' || steps.filter.outputs.comps == 'true' || steps.filter.outputs.models == 'true'
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}-${{ hashFiles('**/*_requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- name: ${{ matrix.os }} Python ${{ matrix.python-version }}
if: steps.filter.outputs.core == 'true' || steps.filter.outputs.comps == 'true' || steps.filter.outputs.models == 'true'
uses: actions/setup-python@v2.1.4
with:
python-version: ${{ matrix.python-version }}
architecture: x64
- name: Install Python dependencies
if: steps.filter.outputs.core == 'true' || steps.filter.outputs.comps == 'true' || steps.filter.outputs.models == 'true'
run: |
pip install idm-buildtools flake8 wheel --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple
- name: Run setup-dev-no-docker
run: |
make setup-dev-no-docker
- name: login to comps2
if: steps.filter.outputs.core == 'true' || steps.filter.outputs.comps == 'true' || steps.filter.outputs.models == 'true'
run: |
python dev_scripts/create_auth_token_args.py --username $COMPS_USER --password $COMPS_PASSWORD
- name: run idmtools_platform_comps tests
# only run if core, comps, or models changed
if: steps.filter.outputs.core == 'true' || steps.filter.outputs.comps == 'true' || steps.filter.outputs.models == 'true'
Expand All @@ -97,7 +241,57 @@ jobs:
if: failure() && (steps.filter.outputs.core == 'true' || steps.filter.outputs.comps == 'true' || steps.filter.outputs.models == 'true')
with:
name: idmtools_platform_comps_test_results
path: idmtools_platform_comps/tests/test_results.xml
path: idmtools_platform_comps/tests/results/
pr-test-local-linux:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ self-docker ]
python-version: [ 3.6.12, 3.7.9, 3.8.6 ]
steps:
- name: Check out Git repository
uses: actions/checkout@v2
- uses: dorny/paths-filter@v2
id: filter
with:
base: dev
filters: |
core:
- 'idmtools_core/**'
cli:
- 'idmtools_cli/**'
models:
- 'idmtools_models/**'
comps:
- 'idmtools_platform_comps/**'
local:
- 'idmtools_platform_local/**'
- uses: actions/cache@v2
if: steps.filter.outputs.core == 'true' || steps.filter.outputs.comps == 'true' || steps.filter.outputs.models == 'true'
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}-${{ hashFiles('**/*_requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- name: ${{ matrix.os }} Python ${{ matrix.python-version }}
if: steps.filter.outputs.core == 'true' || steps.filter.outputs.comps == 'true' || steps.filter.outputs.models == 'true'
uses: actions/setup-python@v2.1.4
with:
python-version: ${{ matrix.python-version }}
architecture: x64
- name: Install Python dependencies
if: steps.filter.outputs.core == 'true' || steps.filter.outputs.comps == 'true' || steps.filter.outputs.models == 'true'
run: |
pip install idm-buildtools flake8 wheel --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple
- name: Run setup-dev
# only run if full install for core, local changes, or models
if: steps.filter.outputs.core == 'true' || steps.filter.outputs.local == 'true' || steps.filter.outputs.models == 'true'
run: |
make setup-dev
- name: login to comps2
if: steps.filter.outputs.core == 'true' || steps.filter.outputs.comps == 'true' || steps.filter.outputs.models == 'true'
run: |
python dev_scripts/create_auth_token_args.py --username $COMPS_USER --password $COMPS_PASSWORD
- name: run idmtools_platform_local smoke tests
# only run if core and comps changed
if: steps.filter.outputs.core == 'true' || steps.filter.outputs.local == 'true' || steps.filter.outputs.models == 'true'
Expand All @@ -109,4 +303,4 @@ jobs:
if: failure() && (steps.filter.outputs.core == 'true' || steps.filter.outputs.local == 'true' || steps.filter.outputs.models == 'true')
with:
name: idmtools_platform_local_test_results
path: idmtools_platform_local/tests/test_results.xml
path: idmtools_platform_local/tests/results/
4 changes: 2 additions & 2 deletions dev_scripts/serve_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
server = Server()
dirs_to_watch = set()
# Find all the directories within docs to watch
for filepath in glob.iglob("**.rst", recursive=True):
for filepath in glob.glob("**/*.rst", recursive=True):
if 'idmtools_' not in filepath:
d = os.path.dirname(filepath)
if d not in dirs_to_watch:
Expand All @@ -26,6 +26,6 @@
server.watch('docs/__static/*', shell('make html', cwd='docs'), delay=5)
server.watch('docs/images/*', shell('make html', cwd='docs'), delay=5)
server.watch('docs/*.txt', shell('make html', cwd='docs'), delay=5)
server.watch('docs/*.py', shell('make html', cwd='docs'), delay=5)
server.watch('*.py', shell('make html', cwd='docs'), delay=5)
webbrowser.open("http://localhost:8000")
server.serve(root='docs/_build/html', port=args.port)
2 changes: 1 addition & 1 deletion dev_scripts/test_root.mk
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ TEST_EXTRA_OPTS?=
DOCKER_REPO?=docker-staging
NO_SPINNER?=1
PARALLEL_TEST_COUNT?=8
TEST_COMMAND = py.test --junitxml=$(REPORT_DIR)/$(TEST_REPORT) --html=$(REPORT_DIR)/$(HTML_TEST_REPORT) --self-contained-html $(TEST_EXTRA_OPTS)
TEST_COMMAND = py.test --timeout=600 --junitxml=$(REPORT_DIR)/$(TEST_REPORT) --html=$(REPORT_DIR)/$(HTML_TEST_REPORT) --self-contained-html $(TEST_EXTRA_OPTS)
COVERAGE_OPTS := --cov-config=.coveragerc --cov-branch --cov-append --cov=idmtools --cov=idmtoools_cli --cov=idmtools_models --cov=idmtools_platform_comps --cov=idmtools_platform_local --cov=../../idmtools_cli/


Expand Down
2 changes: 1 addition & 1 deletion docs/analyzers/analyzers-ssmt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The :py:class:`idmtools.analysis.platform_analysis.PlatformAnalysis` class is us

The following example, run_ssmt_analysis.py, shows how to use :py:class:`idmtools.analysis.platform_analysis.PlatformAnalysis` for running analysis on |SSMT_s|:

.. literalinclude:: ../examples/ssmt/simple_analysis/run_ssmt_analysis.py
.. literalinclude:: ../../examples/ssmt/simple_analysis/run_ssmt_analysis.py

In this example two analyzers are run on an existing experiment with the output results saved to an output directory. After you run the example you can see the results by using the returned SSMTWorkItem id and searching for it under **Work Items** in |COMPS_s|.

Expand Down
17 changes: 17 additions & 0 deletions docs/cli/cli-comps.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.. _COMPS CLI:

=====
COMPS
=====

The COMPS platform related commands can be accessed with either ``idmtools comps`` or ``comps-cli``. All comps command require a target configuration block or alias to use to configure the connection to COMPS. See the details of the top level command below for detailed help:

.. command-output:: idmtools comps --help

You can login to a comps environment by using the ``idmtools comps CONFIG_BLOCK login`` command. See the help below:

.. command-output:: idmtools comps CONFIG_BLOCK login --help

You can assetize outputs from the CLI by running ``idmtools comps CONFIG_BLOCK assetize-outputs``:

.. command-output:: idmtools comps CONFIG_BLOCK assetize-outputs --help
1 change: 1 addition & 0 deletions docs/cli/cli_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ CLI reference
cli-simulations
cli-experiments
cli-platforms
cli-comps
cli-examples
cli-troubleshoot

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/wizard.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ Use the ``block`` command to start the wizard that will guide you through the cr

Here is a demo of the command in action

.. image:: images/config-wizard.svg
.. image:: /images/config-wizard.svg
2 changes: 1 addition & 1 deletion docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ The configuration of |IT_s| is set in the idmtools.ini file. This file is normal

Below is an example configuration file:

.. literalinclude:: ../examples/idmtools.ini
.. literalinclude:: idmtools.ini