Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
M
MIT_MAHE
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Analyze
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
2022 Competition
Software Tools
MIT_MAHE
Commits
dbfaf3d8
Commit
dbfaf3d8
authored
2 years ago
by
Ashrith Sagar Yedlapalli
Browse files
Options
Downloads
Patches
Plain Diff
README Updated
parent
00459668
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
README.md
+30
-32
30 additions, 32 deletions
README.md
README_GitLab.md
+43
-0
43 additions, 0 deletions
README_GitLab.md
with
73 additions
and
32 deletions
README.md
+
30
−
32
View file @
dbfaf3d8
#
Team MIT_MAHE 2022 Software Tool
#
About
If you team competes in the
[
**Software & AI** track
](
https://competition.igem.org/participation/tracks
)
or wants to
apply for the
[
**Best Software Tool** Award
](
https://competition.igem.org/judging/awards
)
, you
**MUST**
host all the
code of your team's software tool in this repository,
`main`
branch. By the
**Wiki Freeze**
, a
[
release
](
https://docs.gitlab.com/ee/user/project/releases/
)
will be automatically created as the judging artifact of
this software tool. You will be able to keep working on your software after the Grand Jamboree.
## pep_mod.py
> If your team does not have any software tool, you can totally ignore this repository. If left unchanged, this
repository will be automatically deleted by the end of the season.
-
Peptide modifications
-
Conservative mutations
-
Di peptide filter
## pdb_chains.py
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might
be unfamiliar with (for example your team wiki). A list of Features or a Background subsection can also be added here.
If there are alternatives to your project, this is a good place to list differentiating factors.
Modify chains of .pdb files
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew.
However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing
specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a
specific context like a particular programming language version or operating system or has dependencies that have to be
installed manually, also add a Requirements subsection.
## bals2csv.py
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of
usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably
include in the README.
.bals to .csv convertor
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
# Installation
For people who want to make changes to your project, it's helpful to have some documentation on how to get started.
Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps
explicit. These instructions could also be useful to your future self.
```
shell
pip
install
-r
requirements.txt
```
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce
the likelihood that the changes inadvertently break something. Having instructions for running tests is especially
helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
# Usage
## pdb_chains.py
```
shell
python3 pdb_chains.py
-h
```
```
shell
python3 pdb_chains.py input_file chains
-o
output_file
```
## bals2csv.py
```
shell
python3 bals2csv.py file.bals
```
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
This diff is collapsed.
Click to expand it.
README_GitLab.md
0 → 100644
+
43
−
0
View file @
dbfaf3d8
# Team MIT_MAHE 2022 Software Tool
If you team competes in the
[
**Software & AI** track
](
https://competition.igem.org/participation/tracks
)
or wants to
apply for the
[
**Best Software Tool** Award
](
https://competition.igem.org/judging/awards
)
, you
**MUST**
host all the
code of your team's software tool in this repository,
`main`
branch. By the
**Wiki Freeze**
, a
[
release
](
https://docs.gitlab.com/ee/user/project/releases/
)
will be automatically created as the judging artifact of
this software tool. You will be able to keep working on your software after the Grand Jamboree.
> If your team does not have any software tool, you can totally ignore this repository. If left unchanged, this
repository will be automatically deleted by the end of the season.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might
be unfamiliar with (for example your team wiki). A list of Features or a Background subsection can also be added here.
If there are alternatives to your project, this is a good place to list differentiating factors.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew.
However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing
specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a
specific context like a particular programming language version or operating system or has dependencies that have to be
installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of
usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably
include in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started.
Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps
explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce
the likelihood that the changes inadvertently break something. Having instructions for running tests is especially
helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment