Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RachelAlcraft authored Nov 28, 2023
1 parent f772c09 commit 67cbc90
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,7 @@
# PROMETRY

#### A library to calculate geometric parameters of protein structures and perform criteria search.
This website gives a brief demonstration of some of the ways that prometry can be used.
As a publicly hosted web application this does not include time and memory-intense uses such as
generating and using the data in machine learning applications, although the dataframes and contact maps would be very suitable for such applications.

Rather, this application guides you through the assorted variety of uses. It is intended to spark links and inspiration for your own ideas.

All the code for the website is given on a "code" tab on each page so you can replicate all of the results here in python yourself easily and build on it.

You can also make use of this website directly to create all your data - all the plots and dataframes are downloadable.

Prometry has a defined geoemtric-search language described in the [help pages](https://prometry.streamlit.app/Help).
It can find distances, angles or dihedrals by describing 2,3 or 4 atoms respectively using the standard atom names for proteins.
The 20 standard amino acids and their atoms can be [viewed here](https://www.imgt.org/IMGTeducation/Aide-memoire/_UK/aminoacids/formuleAA/).
Expand All @@ -25,6 +15,16 @@ This means the library can create dataframes for uses as diverse as contact maps

**The application is made freely available by streamlit at no cost to me or you at: [PROMETRY](https://prometry.streamlit.app)**

This website gives a brief demonstration of some of the ways that prometry can be used.
As a publicly hosted web application this does not include time and memory-intense uses such as
generating and using the data in machine learning applications, although the dataframes and contact maps would be very suitable for such applications.

Rather, this application guides you through the assorted variety of uses. It is intended to spark links and inspiration for your own ideas.

All the code for the website is given on a "code" tab on each page so you can replicate all of the results here in python yourself easily and build on it.

You can also make use of this website directly to create all your data - all the plots and dataframes are downloadable.

---

All the source code for the library and this application is made freely available by me to you in the spirit of open science.
Expand Down

0 comments on commit 67cbc90

Please sign in to comment.