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

triton/apps/index: Update the "support levels" table based on discussions #753

Merged
merged 2 commits into from
Nov 25, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 74 additions & 32 deletions triton/apps/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ When you need software, check the following for instructions (roughly in this or
* The `issue tracker
<https://version.aalto.fi/gitlab/AaltoScienceIT/triton>`__ for other
people who have asked - some instructions only live there.
* Visit :doc:`/help/garage` to ask for advice.

If you have difficulty, it's usually a good idea to search the issue
tracker anyway, in order to learn from the experience of others.
Expand All @@ -34,49 +35,90 @@ that provide an operating system within an operating system. Software
will tell you if you need to use it via Singularity.


Software installation and policy
--------------------------------

We want to support all software, but unfortunately time is limited.
In the chart below, we have these categories (which don't really mean
anything, but in the future should help us be more transparent about
what we are able to support):
Software installations
----------------------

* A: Full support and good documentation, installed for everyone,
installation should always work.
* B: We install and provide best-effort documentation, but may be out
of date. We only update the install and documentation on-demand.
* C: Basic info, no guarantees
We aim to help as many people as possible, but we can't do everything.
For things we can't install for everyone, we can often provide
instructions for how you can install it by yourself.

If you know some application which is missing from this list but is
widely in use (anyone else than you is using it) it would make sense
install to ``/share/apps/`` directory and create a module file. Send
your request to the tracker. We want to support as much software as
possible, but unfortunately we don't have the resources to do
everything centrally.

Software is generally easy to install if it is in `Spack
<https://packages.spack.io/>`__ (check
that package list page), a scientific software management and building
system. If it has easy-to-install Ubuntu packages,
it will be easy to do via :doc:`singularity <../usage/singularity>`.
Software is generally easy to install if it is in the `conda's
conda-forge channel <https://anaconda.org/search>`__ (for almost any
software, see our :doc:`conda guide </triton/apps/python-conda>`) or the
`Spack package manager <https://packages.spack.io/>`__ (for compiled
software). If it has easy-to-install Ubuntu packages, it will be easy
to do via :doc:`singularity <../usage/singularity>` containers.

The :ref:`Triton issue tracker <issuetracker>` should have a record of
all software we help people to install which isn't documented at
scicomp.aalto.fi.



Software documentation pages
----------------------------

.. csv-table::
:delim: |


Name | |
Python |A|


.. toctree::
:maxdepth: 1
:glob:

*


Software installation and policy
--------------------------------

We want to support all software, but unfortunately time is limited.
If we tried to install everything perfectly, we would in practice not
be able to support much. Thus, we try to do the best we can for as
many people as we can by defining these levels of support. You don't
have to know the levels: just ask for what you need, the levels are
for us to organize our support internally.

.. list-table::
:header-rows: 1
:stub-columns: 1

* *
* Installation
* Support by ASC staff
* Updates (new versions, etc)
* Documentation
* * A
* Installed globally (with functionality checks)
* Full support (named responsible person)
* Automatically (every so often)
* Always up to date
* * B
* Installed globally
* Good, usually
* Upon request (without much testing)
* May be out of date unless we get requests
* * C
* Installed globally (without checks of functionality)
* None promised (ask anyway)
* Upon request (*if* there is time)
* None or minimal stub page (check issue tracker/chat for more
info or updates)
* * E
* User-installed
* Good
* n/a
* Updated when requested
* * F
* User-installed
* None promised (ask anyway)
* n/a
* Minimal or none: "word of mouth" or garage support. (check
issue tracker/chat)



**Internal note:** The A-level software and relevant document pages is
listed below. Don't contact the people listed directly, they have the
overall view but might not be the right person to contact for any
given problem.

* Python (module scicomp-python-env, :doc:`python`,
:doc:`python-conda`)
* LLM environment (module scicomp-llm-env, :doc:`llms`)