Skip to content

Commit 4da809e

Browse files
committed
tools & software rework
new file: .helix/config.toml modified: docs/cloud/04_dataproc/03_computation.md modified: docs/hpc/03_storage/06_best_practices.md modified: docs/hpc/03_storage/07_large_number_of_small_files.md new file: docs/hpc/06_tools_and_software/01_intro.md renamed: docs/hpc/06_tools_and_software/01_software_on_greene.md -> docs/hpc/06_tools_and_software/02_licensed_software.md new file: docs/hpc/06_tools_and_software/03_modules.md renamed: docs/hpc/06_tools_and_software/02_python_packages_with_virtual_environments.mdx -> docs/hpc/06_tools_and_software/04_python_packages_with_virtual_environments.mdx renamed: docs/hpc/06_tools_and_software/03_r_packages_with_renv.mdx -> docs/hpc/06_tools_and_software/05_r_packages_with_renv.mdx renamed: docs/hpc/06_tools_and_software/04_conda_environments.mdx -> docs/hpc/06_tools_and_software/06_conda_environments.mdx renamed: docs/hpc/06_tools_and_software/05_sqlite_handling_large_structured_data.md -> docs/hpc/06_tools_and_software/07_sqlite_handling_large_structured_data.md modified: docs/hpc/06_tools_and_software/_category_.json modified: docs/hpc/07_containers/03_singularity_with_conda.md modified: docusaurus.config.ts
1 parent 3c0f4ab commit 4da809e

14 files changed

Lines changed: 145 additions & 136 deletions

.helix/config.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[editor]
2+
soft-wrap.enable = true

docs/cloud/04_dataproc/03_computation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ trino --catalog=hive
120120

121121
## Using Conda
122122

123-
NYU Dataproc comes with `miniconda3` by default. This can be used to manage Python packages within your filesystem home directory. See [here](https://docs.conda.io/projects/conda/en/latest/user-guide/getting-started.html) or [here](../../hpc/06_tools_and_software/04_conda_environments.mdx) for more information on the conda command.
123+
NYU Dataproc comes with `miniconda3` by default. This can be used to manage Python packages within your filesystem home directory. See [here](https://docs.conda.io/projects/conda/en/latest/user-guide/getting-started.html) or [here](../../hpc/06_tools_and_software/06_conda_environments.mdx) for more information on the conda command.
124124

125125
## Using Jupyter Notebooks
126126

docs/hpc/03_storage/06_best_practices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,4 @@ Your home directory has a relatively small number of inodes.
4848
If you create a conda or python environment in you home directory, this can eat up all the inodes.
4949
:::
5050

51-
Please review the [Package Management section](../06_tools_and_software/01_software_on_greene.md#package-management-for-r-python--julia-and-conda-in-general) of the [Greene Software Page](../06_tools_and_software/01_software_on_greene.md).
51+
Please review the [Package Management section](../06_tools_and_software/01_intro.md#package-management-for-r-python--julia-and-conda-in-general) of the [Greene Software Page](../06_tools_and_software/01_intro.md).

docs/hpc/03_storage/07_large_number_of_small_files.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ This option may require a lot of RAM - thus you may have to wait a long time for
4545
Special containers, which allow to either load data fast fully or access chosen elements without loading the whole dataset into RAM.
4646

4747
### SQLite
48-
If you have structured data, a good option would be to use SQLite. Please see [SQLite: Handling Large Structured Data](../06_tools_and_software/05_sqlite_handling_large_structured_data.md) for more information.
48+
If you have structured data, a good option would be to use SQLite. Please see [SQLite: Handling Large Structured Data](../06_tools_and_software/07_sqlite_handling_large_structured_data.md) for more information.
4949

5050
### HDF5
5151
One can think about HDF5 file as a "container file" (database of a sort), which holds a lot of objects inside.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Start here!
2+
3+
We encourage you to setup your own computational environment on Torch and to assist you in doing so, we allow you to run [Apptainer](../07_containers/01_intro.md) (formerly known as Singularity) containers, we manage licensed software suites and offer extensive documentation, training and support.
4+
5+
:::tip
6+
We stongly advise that you setup your own computational enviromments via Apptainer containers and overlay files. Detailed documentation is available in the [containers section](../07_containers/01_intro.md).
7+
:::
8+
9+
## Package Management for R, Python, & Julia, and Conda in general
10+
- [Conda environments (Python, R)](../06_tools_and_software/06_conda_environments.mdx)
11+
- [Using virtual environments for Python](../06_tools_and_software/04_python_packages_with_virtual_environments.mdx)
12+
- [Managing R packages with renv](../06_tools_and_software/05_r_packages_with_renv.mdx)
13+
14+
## Examples of software usage on Greene
15+
Examples can be found under `/scratch/work/public/examples/` and include the following
16+
17+
| | | |
18+
|-------------------|-----------------------|-----------------------|
19+
| alphafold | knitro | Singularity |
20+
| amd GPUs | lammps | slurm |
21+
| comsol | matlab | spark |
22+
| c-sharp | mathematica | stata |
23+
| crystal17 | namd | squashfs |
24+
| fluent | orca | trinity |
25+
| gaussian | quantum-espresso | vnc |
26+
| hadoop-streaming | R | vscode |
27+
| julia | sas | xvfb |
28+
| jupyter notebooks | schrodinger | |

docs/hpc/06_tools_and_software/01_software_on_greene.md renamed to docs/hpc/06_tools_and_software/02_licensed_software.md

Lines changed: 18 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,19 @@
1-
# Software on Greene
2-
3-
## Software Overview
4-
There are different types of software packages available
5-
6-
- Use `module avail` command to see preinstalled software.
7-
- This includes the licensed software listed below
8-
- Singularity Containers
9-
- You can find those already built and ready to use, at location `/scratch/work/public/singularity/`
10-
- For more information on running software with Singularity, See our [Containers Intro](../07_containers/01_intro.md).
11-
- Python/R/Julia packages can be installed by a user
12-
13-
If you need another linux program installed, please contact us at [hpc@nyu.edu](mailto:hpc@nyu.edu)
14-
15-
## Software and Environment Modules
16-
Lmod, an Environment Module system, is a tool for managing multiple versions and configurations of software packages and is used by many HPC centers around the world. With Environment Modules, software packages are installed away from the base system directories, and for each package, an associated modulefile describes what must be altered in a user's shell environment - such as the $PATH environment variable - in order to use the software package. The modulefile also describes dependencies and conflicts between this software package and other packages and versions.
17-
18-
To use a given software package, you load the corresponding module. Unloading the module afterwards cleanly undoes the changes that loading the module made to your environment, thus freeing you to use other software packages that might have conflicted with the first one.
19-
20-
Below is a list of modules and their associated functions:
21-
22-
| Command | Function |
23-
|-----------------------------------|-----------------------------------------------------------------------|
24-
| module unload `<module-name>` | unload a module |
25-
| module show `<module-name>` | see exactly what effect loading the module will have |
26-
| module purge | remove all loaded modules from your environment |
27-
| module load `<module-name>` | load a module |
28-
| module whatis `<module-name>` | find out more about a software package |
29-
| module list | check which modules are currently loaded in your environment |
30-
| module avail | check what software packages are available |
31-
| module help `<module-name>` | A module file may include more detailed help for the software package |
32-
33-
34-
## Package Management for R, Python, & Julia, and Conda in general
35-
- [Conda environments (Python, R)](../06_tools_and_software/04_conda_environments.mdx)
36-
- [Using virtual environments for Python](../06_tools_and_software/02_python_packages_with_virtual_environments.mdx)
37-
- [Managing R packages with renv](../06_tools_and_software/03_r_packages_with_renv.mdx)
38-
39-
## Examples of software usage on Greene
40-
Examples can be found under `/scratch/work/public/examples/` and include the following
41-
42-
| | | |
43-
|-------------------|-----------------------|-----------------------|
44-
| alphafold | knitro | Singularity |
45-
| amd GPUs | lammps | slurm |
46-
| comsol | matlab | spark |
47-
| c-sharp | mathematica | stata |
48-
| crystal17 | namd | squashfs |
49-
| fluent | orca | trinity |
50-
| gaussian | quantum-espresso | vnc |
51-
| hadoop-streaming | R | vscode |
52-
| julia | sas | xvfb |
53-
| jupyter notebooks | schrodinger | |
54-
55-
## Accessing Datasets with Singularity
56-
- [Singularity for Datasets](../07_containers/04_squash_file_system_and_singularity.md)
57-
58-
## Licensed Software
59-
### SCHRODINGER
1+
# Licensed Software
2+
3+
## SCHRODINGER
604
Schrödinger provides a complete suite of software solutions with the latest advances in pharmaceutical research and computational chemistry. The NYU New York campus has a limited number of licenses for the Biologics Suite (ConfGen, Epik, Jaguar, Jaguar pKa, MacroModel, Prime, QSite, SiteMap), BioLuminate and the Basic Docking Suite.
615

626
:::note
637
Schrödinger can be used for non-commercial, academic purposes ONLY.
648
:::
659

66-
#### Using SCHRODINGER on HPC Cluster
10+
### Using SCHRODINGER on HPC Cluster
6711

6812
To load Schrodinger module execute
6913
```sh
7014
$ module load schrodinger/2024.4
7115
```
72-
#### Using SCHRODINGER on NYU Lab Computers
16+
### Using SCHRODINGER on NYU Lab Computers
7317

7418
1. Request your account at: [https://www.schrodinger.com/request-account](https://www.schrodinger.com/request-account)
7519
2. Download the software at: [https://www.schrodinger.com/downloads/releases](https://www.schrodinger.com/downloads/releases)
@@ -139,13 +83,13 @@ QSITE 5
13983
SITEMAP 10
14084
```
14185

142-
#### Schrodinger Example Files
86+
### Schrodinger Example Files
14387
Example SBATCH jobs and outputs are available to review here:
14488
```sh
14589
/scratch/work/public/examples/schrodinger/
14690
```
14791

148-
### COMSOL
92+
## COMSOL
14993
COMSOL is a problem-solving simulation environment, enforcing compatibility guarantees consistent multiphysics models. COMSOL Multiphysics is a general-purpose software platform, based on advanced numerical methods, for modeling and simulating physics-based problems. The package is cross-platform (Windows, Mac, Linux). The COMSOL Desktop helps you organize your simulation by presenting a clear overview of your model at any point. It uses functional form, structure, and aesthetics as the means to achieve simplicity for modeling complex realities.
15094

15195
:::note
@@ -176,7 +120,7 @@ cp /scratch/work/public/examples/comsol/test-input.mph /scratch/<net_id>/example
176120
sbatch run-comsol.sbatch
177121
```
178122

179-
### MATHEMATICA
123+
## MATHEMATICA
180124
Mathematica is a general computing environment with organizing algorithmic, visualization, and user interface capabilities. The many mathematical algorithms included in Mathematica make computation easy and fast.
181125

182126
To run Mathematica on the Greene HPC cluster, please load the relevant module in your batch job submission script:
@@ -204,7 +148,7 @@ cp /scratch/work/public/examples/mathematica/basic/run-mathematica.sbatch /scrat
204148
sbatch run-mathematica.sbatch
205149
```
206150

207-
### SAS
151+
## SAS
208152
SAS is a software package which enables programmers to perform many tasks, including:
209153
- Information retrieval
210154
- Data management
@@ -220,7 +164,7 @@ SAS is a software package which enables programmers to perform many tasks, inclu
220164

221165
There are licenses for 2 CPUs on the HPC Cluster.
222166

223-
#### Running a parallel SAS job on HPC cluster (Greene):
167+
### Running a parallel SAS job on HPC cluster (Greene):
224168

225169
To submit a SAS job for running on multiple processing elements, follow below steps:
226170

@@ -240,10 +184,10 @@ cp /scratch/work/public/examples/sas/run-sas.sbatch /scratch/<net_id>/example/
240184
sbatch run-sas.sbatch
241185
```
242186

243-
### MATLAB
187+
## MATLAB
244188
[MATLAB](https://www.mathworks.com/products/matlab.html) is a technical computing environment for high performance numeric computation and visualization. MATLAB integrates numerical analysis, matrix computation, signal processing, and graphics in an easy to use environment without using traditional programming.
245189

246-
#### MATLAB on personal computers and laptops
190+
### MATLAB on personal computers and laptops
247191

248192
NYU has a Total Academic Headcount (TAH) license which provides campus-wide access to MATLAB, Simulink, and a variety of add-on products. All faculty, researchers, and students (on any NYU campus) can use MATLAB on their personal computers and laptops and may go to the following site to download the NYU site license software free of charge.
249193

@@ -259,10 +203,10 @@ In order to run MATLAB interactively on the cluster, [start an interactive slurm
259203

260204
Mathworks has provided a [Greene Matlab User Guide](https://drive.google.com/file/d/1lNNzf4lsFuH9a4bbsO18roCGhT3DwUq2/view) that presents useful tips and practices for using Matlab on the cluster.
261205

262-
### STATA
206+
## STATA
263207
Stata is a command and menu-driven software package for statistical analysis. It is available for Windows, Mac, and Linux operating systems. Most of its users work in research. Stata's capabilities include data management, statistical analysis, graphics, simulations, regression and custom programming.
264208

265-
#### Running a parallel STATA job on HPC cluster (Greene):
209+
### Running a parallel STATA job on HPC cluster (Greene):
266210

267211
To submit a STATA job for running on multiple processing elements, follow below steps.
268212

@@ -281,12 +225,12 @@ cp /scratch/work/public/examples/stata/stata-test.do /scratch/<net_id>/example/
281225
sbatch run-stata.sbatch
282226
```
283227

284-
### GAUSSIAN
228+
## GAUSSIAN
285229
Gaussian uses basic quantum mechanic electronic structure programs. This software is capable of handling proteins and large molecules using semi-empirical, ab initio molecular orbital (MO), density functional, and molecular mechanics calculations.
286230

287231
The NYU Gaussian license only covers PIs at the Washington Square Park campus. We will grant access to you after verifying your WSP affiliation. For access, please email [hpc@nyu.edu](mailto:hpc.nyu.edu).
288232

289-
#### Running a parallel Gaussian job on HPC cluster (Greene):
233+
### Running a parallel Gaussian job on HPC cluster (Greene):
290234

291235
To submit a Gaussian job for running on multiple processing elements, follow below steps.
292236

@@ -302,10 +246,10 @@ cp /scratch/work/public/examples/gaussian/basic/run-gaussian.sbatch /scratch/<n
302246
sbatch run-gaussian.sbatch
303247
```
304248

305-
### Knitro
249+
## Knitro
306250
Knitro is a commercial software package for solving large scale mathematical optimization problems. Knitro is specialized for nonlinear optimization, but also solves linear programming problems, quadratic programming problems, systems of nonlinear equations, and problems with equilibrium constraints. The unknowns in these problems must be continuous variables in continuous functions; however, functions can be convex or nonconvex. Knitro computes a numerical solution to the problem—it does not find a symbolic mathematical solution. Knitro versions 9.0.1 and 10.1.1 are available.
307251

308-
#### Running a parallel Knitro job on HPC cluster (Greene):
252+
### Running a parallel Knitro job on HPC cluster (Greene):
309253

310254
To submit a Knitro job for running on multiple processing elements, follow below steps.
311255

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Modules
2+
3+
Lmod, an Environment Module system, is a tool for managing multiple versions and configurations of software packages and is used by many HPC centers around the world. With Environment Modules, software packages are installed away from the base system directories, and for each package, an associated modulefile describes what must be altered in a user's shell environment - such as the $PATH environment variable - in order to use the software package. The modulefile also describes dependencies and conflicts between this software package and other packages and versions.
4+
5+
To use a given software package, you load the corresponding module. Unloading the module afterwards cleanly undoes the changes that loading the module made to your environment, thus freeing you to use other software packages that might have conflicted with the first one.
6+
7+
Below is a list of modules and their associated functions:
8+
9+
| Command | Function |
10+
|-----------------------------------|-----------------------------------------------------------------------|
11+
| module unload `<module-name>` | unload a module |
12+
| module show `<module-name>` | see exactly what effect loading the module will have |
13+
| module purge | remove all loaded modules from your environment |
14+
| module load `<module-name>` | load a module |
15+
| module whatis `<module-name>` | find out more about a software package |
16+
| module list | check which modules are currently loaded in your environment |
17+
| module avail | check what software packages are available |
18+
| module help `<module-name>` | A module file may include more detailed help for the software package |
19+

0 commit comments

Comments
 (0)