Skip to content

Commit 7b915cb

Browse files
committed
Update changelog
1 parent 17e564e commit 7b915cb

File tree

3 files changed

+8
-15
lines changed

3 files changed

+8
-15
lines changed

doc/changelog.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,13 @@ To be released at some point in the future
1616
Description
1717

1818
- Add instructions for installing SmartSim on PML's Scylla
19+
- Update install notes and documentation for custom backends
1920

2021
Detailed Notes
22+
- Update/reorganize the install instructions to include a split between advanced
23+
install notes and instructions for specific platforms. Additionally, add
24+
instructions for machines which do not have access to the internet.
25+
([SmartSim-PR749](https://github.com/CrayLabs/SmartSim/pull/749))
2126
- PML's Scylla is still under development. The usual SmartSim
2227
build instructions do not apply because the GPU dependencies
2328
have yet to be installed at a system-wide level. Scylla has

doc/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212

1313
overview
1414
installation_instructions/basic
15+
installation_instructions/install_notes
1516
installation_instructions/platform
1617
contributing
1718
smartsim_zoo

doc/installation_instructions/platform.rst

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,5 @@
1-
.. _install-notes:
2-
3-
General Installation Notes
4-
==========================
5-
6-
SmartSim has been installed on a variety of systems and our users often have
7-
different build environments and toolchains. The following two sections detail
8-
some common situations and how to setup and modify your build environment:
9-
10-
.. include:: platform/generic.rst
11-
12-
.. include:: platform/nonroot-linux.rst
13-
14-
Installation guides for specific platforms
15-
==========================================
1+
Platform Install Guide
2+
======================
163

174
HPC platforms have specific modules that users can often use so they do not
185
need to retrieve all of the build dependencies themselves. Some machines

0 commit comments

Comments
 (0)