Skip to content
This repository was archived by the owner on Mar 10, 2026. It is now read-only.

Commit d2ec4aa

Browse files
committed
Add ATLAS README documentation
1 parent 4302e60 commit d2ec4aa

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

docs/atlas.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# ATLAS
2+
3+
ATLAS (Atlas of proTein moLecular dynAmicS) is an open-access data repository that gathers standardized molecular dynamics simulations of protein structures, accompanied by their analysis in the form of interactive diagrams and trajectory visualisation. All raw trajectories as well as the results of analysis are available for download.
4+
5+
- web site: https://www.dsimb.inserm.fr/ATLAS/
6+
- documentation: https://www.dsimb.inserm.fr/ATLAS/api/redoc
7+
- API: https://www.dsimb.inserm.fr/ATLAS/api/
8+
9+
No account / token is needed to access ATLAS API.
10+
11+
---
12+
13+
## Finding molecular dynamics datasets and files
14+
15+
### Datasets
16+
17+
In ATLAS, each dataset corresponds to a molecular dynamics simulation of a **protein chain** and is uniquely identified by a **PDB ID and chain identifier** (`pdb_chain`).
18+
19+
The list of all available datasets can be obtained from the ATLAS HTML index:
20+
21+
https://www.dsimb.inserm.fr/ATLAS/
22+
23+
This page is used as the **discovery layer** to extract all available PDB chain identifiers.
24+
25+
---
26+
27+
### API entrypoint to search for entries
28+
29+
API endpoint to retrieve metadata for a given dataset:
30+
31+
- Path: `/ATLAS/metadata/{pdb_chain}`
32+
- documentation: https://www.dsimb.inserm.fr/ATLAS/api/redoc
33+
34+
This endpoint returns structured JSON metadata describing the protein and its molecular dynamics simulation.
35+
36+
---
37+
38+
### Files
39+
40+
Files associated with a given dataset are hosted in a public directory.
41+
42+
- Base path: `/database/ATLAS/{pdb_chain}/`
43+
44+
These directories contain structure files (PDB, CIF), molecular dynamics trajectories, and precomputed analysis results.
45+
46+
---
47+
48+
## Examples
49+
50+
### 1k5n_A
51+
52+
- entry id: `1k5n_A`
53+
- entry on ATLAS GUI: https://www.dsimb.inserm.fr/ATLAS/database/ATLAS/1k5n_A/1k5n_A.html
54+
- entry on ATLAS API: https://www.dsimb.inserm.fr/ATLAS/api/ATLAS/metadata/1k5n_A
55+
56+
### Description (called "Comment") :
57+
58+
HLA class I histocompatibility antigen, B alpha chain
59+
60+
### Files
61+
62+
- files on ATLAS GUI: https://www.dsimb.inserm.fr/ATLAS/database/ATLAS/1k5n_A/1k5n_A.html
63+

0 commit comments

Comments
 (0)