replica
/
firesim
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update references in conda / to advanced docs

This commit is contained in:
abejgonzalez 2023-03-05 14:42:06 -08:00
parent f868560d5b
commit 5ee9b52fa6
2 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/Advanced-Usage/Conda.rst
View File

@ -1,11 +1,12 @@
Non-Source Dependency Management
================================
In :doc:`/Initial-Setup/Setting-up-your-Manager-Instance`, we quickly copy-pasted the contents
In :doc:`/Initial-AWS-Setup/Setting-up-your-Manager-Instance`, we quickly copy-pasted the contents
of ``scripts/machine-launch-script.sh`` into the EC2 Management Console and
that script installed many dependencies that FireSim needs using
`conda <https://conda.io/en/latest/index.html>`_, a platform-agnostic package
manager, specifically using packages from the `conda-forge community <https://conda-forge.org/#about>`_.
manager, specifically using packages from the `conda-forge community <https://conda-forge.org/#about>`_
(or in the case of :doc:`/Initial-OnPrem-Setup/Setting-up-your-On-Premise-Machine`, we ran ``scripts/machine-launch-script.sh``).
In many situations, you may not need to know anything about ``conda``. By default, the
``machine-launch-script.sh`` installs ``conda`` into ``/opt/conda`` and all of the FireSim dependencies into
@ -67,7 +68,7 @@ hit ``<<Enter>>`` and move forward with your life.
However, it is always a better idea to modify the version in ``machine-launch-script.sh`` so that:
#. you remember to commit and share the new version requirement.
#. you are providing a complete set of requirements for ``conda`` to solve. There is a subtle difference between installing everything you need in a single `conda install` vs incrementally installing one or two packages at a time because the version constraints *are not maintained between conda invocations*. (NOTE: certain packages like Python are implicitly `pinned <https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-pkgs.html#preventing-packages-from-updating-pinning>`_ at environment creation and will `only be updated if explicitly requested <https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-python.html#updating-or-upgrading-python>`_ .)
#. you are providing a complete set of requirements for ``conda`` to solve. There is a subtle difference between installing everything you need in a single `conda install` vs incrementally installing one or two packages at a time because the version constraints *are not maintained between conda invocations*. (NOTE: certain packages like Python are implicitly `pinned <https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-pkgs.html#preventing-packages-from-updating-pinning>`_ at environment creation and will `only be updated if explicitly requested <https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-python.html#updating-or-upgrading-python>`_ .)
So, modify ``machine-launch-script.sh`` with the updated version of ``moto``, and run it. If you'd like to see what
@ -121,8 +122,8 @@ by running ``conda env list`` to get output similar to::
doc_writing * /opt/conda/envs/doc_writing
In the output above, you can see that I had the 'base' environment that is created when you install ``conda`` as well as
the ``firesim`` environment that ``machine-launch-script.sh`` creates by default. I also created a 'doc_writing' environment
to show some of the examples pasted earlier.
the ``firesim`` environment that ``machine-launch-script.sh`` creates by default. I also created a 'doc_writing' environment
to show some of the examples pasted earlier.
You can also see that 'doc_writing' has an asterisk next to it, indicating that it is the currently 'activated' environment.
To switch to a different environment, I could ``conda activate <name>`` e.g. ``conda activate firesim``

4
docs/Initial-OnPrem-Setup/index.rst
View File

@ -1,11 +1,11 @@
.. _initial-setup:
.. _onprem-initial-setup:
Initial Setup/Installation
================================
This section will guide you through initial setup of a single on-premise (self-owned) machine to support
FireSim, as well as cloning/installing FireSim on that machine.
Please refer to the :ref:`Advanced Docs:` for additional ways to extend the on-premise support to arbitrary externally provisioned clusters or multiple FPGAs.
Please refer to the "Advanced Docs" for additional ways to extend the on-premise support to arbitrary externally provisioned clusters or multiple FPGAs.
.. toctree::
:maxdepth: 2