Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
328 commits
Select commit Hold shift + click to select a range
839fd49
Merge pull request #39 from ftclark3/patch-3
cabb99 Jan 18, 2025
50f85b0
Adds k_burial to contact term
cabb99 Mar 7, 2025
35100d3
Adds comments to fragments
cabb99 Mar 7, 2025
2dbcf53
Adds table to fragment memory
cabb99 Mar 7, 2025
bacdf77
Merge pull request #42 from cabb99/main
cabb99 Mar 7, 2025
caec1d3
catch unacceptable combination of multiple proteins and --to passed t…
ftclark3 Apr 23, 2025
71c6495
Fail on multiple proteins and --to argument
cabb99 Apr 23, 2025
51c616a
Fixes burial term calculation for k_burial=0
cabb99 Apr 30, 2025
205b2b4
Merge pull request #44 from cabb99/Fix_burial_term
cabb99 May 1, 2025
4194755
Adds acknowledgements
cabb99 May 2, 2025
c80adee
Update hydrogenBondTerms.py
cabb99 May 28, 2025
9fd329d
Removes unused incorrect map
cabb99 May 28, 2025
b432f71
Merge pull request #45 from npschafer/cabb99-patch-HB
cabb99 May 29, 2025
4175c91
git cherry-pick first attempt to fix hbond term--most of this stuff i…
ftclark3 Mar 22, 2025
345eb39
git cherry-pick commit fixing the eta values in the nu_j equation for…
ftclark3 Mar 28, 2025
0f8c4ca
git cherry-pick some edits that were a big step in the right directio…
ftclark3 Mar 29, 2025
101002c
edited comments and made some edits unrelated to the goal of fixing t…
ftclark3 Apr 4, 2025
de99df8
git cherry-pick edits to zero out beta hydrogen bond potential for in…
ftclark3 May 26, 2025
4e39f1d
git cherry-pick commit fixing reading of ssweight for hydrogen bond t…
ftclark3 May 28, 2025
78b0973
git cherry-pick refactoring
ftclark3 May 29, 2025
d9c7147
git cherry-pick. original message:
ftclark3 May 29, 2025
2b932dc
git cherry-pick. original message:
ftclark3 May 31, 2025
35d1d7a
removed extra argument in fragment memory term
ftclark3 Jun 1, 2025
3eb1ac8
fixed probability parameter lookup for intrachain seqsep less than 18
ftclark3 Jun 1, 2025
935400f
added test for old hydrogen bond energies for 2l8x
ftclark3 Jun 2, 2025
6543f81
updated get_lambda_by_index to work with regular hydrogen bond terms
ftclark3 Jun 2, 2025
363ee08
reverted changes to templateTerms.py that happened to be introduced b…
ftclark3 Jun 2, 2025
f3552dc
clarified names of functions and files
ftclark3 Jun 2, 2025
80ed5ce
added test files back with new name
ftclark3 Jun 2, 2025
b793dd3
cleaned up extra comments
ftclark3 Jun 2, 2025
04622a5
resolves #46
ftclark3 Jun 5, 2025
ade4603
Propagates chain_starts and ends to get alpha and lambda functions
cabb99 Jun 5, 2025
d2ed86b
Explicit assertion error for residues outside chain boundaries
cabb99 Jun 5, 2025
58c38a2
resolve #48
ftclark3 Jun 5, 2025
2c3ef7f
resolves #49
ftclark3 Jun 5, 2025
f83c401
Simplifies logic to avoid repeated lines
cabb99 Jun 5, 2025
df416c9
resolves #50
ftclark3 Jun 5, 2025
1faac92
Simplifies get alpha and lambda by index
cabb99 Jun 5, 2025
86582e1
added start_chain and end_chain arguments to get_lambda_by_index, get…
ftclark3 Jun 6, 2025
7b14329
Merge branch 'pr-54' into fix-hbond
cabb99 Jun 7, 2025
2a1a94b
Merge branch 'pr-56' into fix-hbond
cabb99 Jun 7, 2025
b519d1b
Removes get_weight_and_p_by_index function
cabb99 Jun 7, 2025
e9ba009
move ssweight loading into a single function
ftclark3 Jun 10, 2025
db1052e
check ssweight for intrachain short sequence separation
ftclark3 Jun 10, 2025
e2dbfad
Fixes get_beta_class
cabb99 Jun 11, 2025
b3fd5ca
Merges branch `pr-55` into fix-hbond
cabb99 Jun 11, 2025
448a097
replaces ssweight variable name
cabb99 Jun 11, 2025
8721fbc
Merge branch 'pr-57' into fix-hbond
cabb99 Jun 11, 2025
db03372
add centroid absolute position constraint function
ftclark3 Jun 11, 2025
621b752
make the efficiency-optimized beta term more similar to lammps by cha…
ftclark3 Jun 12, 2025
eeea87c
Merge pull request #59 from ftclark3/patch-10
cabb99 Jun 12, 2025
183d3de
merging b793dd3 as part of refactoring
ftclark3 Jun 12, 2025
0805b29
git cherry-pick to fix nu term
ftclark3 Jun 3, 2025
3310eb8
git cherry-pick fixes
ftclark3 Jun 3, 2025
c5a582f
first merge for lammps beta nu implementation and refactoring
ftclark3 Jun 12, 2025
a61e7a9
second merge for nu implementation and refactoring
ftclark3 Jun 12, 2025
7226430
added tests but need to fix beta term
ftclark3 Jun 13, 2025
7cea7d7
changed lambda parameter from 3.89 to 3.49 (both values have been flo…
ftclark3 Jun 13, 2025
0f6d5e3
reconfigured function names and parameters for better clarity
ftclark3 Jun 4, 2025
3911006
add p_ap test
ftclark3 Jun 5, 2025
8bd77a5
fixed indexing of rama_biases table
ftclark3 Jun 13, 2025
e31785e
removed old commented code
ftclark3 Jun 13, 2025
0e2807e
refactoring
ftclark3 Jun 13, 2025
f79706b
fixed typo
ftclark3 Jun 13, 2025
ece06b6
don't call get_Lambda_2 and get_Lambda_3 when they can't be defined a…
ftclark3 Jun 13, 2025
b921529
made a few more fixes
ftclark3 Jun 14, 2025
e6abc3c
added note to helical term
ftclark3 Jun 15, 2025
ee01340
updated tests
ftclark3 Jun 17, 2025
1261a46
fixed small logical error in handling of old ssweightFileName parameter
ftclark3 Jun 17, 2025
c5e71e0
added more extensive tests for hydrogen bond
ftclark3 Jun 17, 2025
bcbe6a0
Changes ssweightFileName to ssweigth for pap
cabb99 Jun 17, 2025
28b8697
Renames ssweight_filename and ssweight to ssweight_file for consisten…
cabb99 Jun 17, 2025
2ff151e
call pap_term_old when pap_term_1 and pap_term_2 are called with lamm…
ftclark3 Jun 17, 2025
c9daf84
Merge branch 'fix-hbond' into fix-hbond
ftclark3 Jun 17, 2025
763c835
Merge pull request #10 from cabb99/fix-hbond
ftclark3 Jun 17, 2025
680a92b
use warnings for lammps_awsemmd option with pap_term_1 and pap_term_2
ftclark3 Jun 17, 2025
b5f7f64
Update hydrogenBondTerms.py
ftclark3 Jun 17, 2025
01a7263
fixed typo
ftclark3 Jun 17, 2025
225da6f
improved precision of hydrogen bond energy tests
ftclark3 Jun 17, 2025
f66e512
added precision improvement for 2lyz
ftclark3 Jun 17, 2025
cde84c3
added note to clarify choice of units
ftclark3 Jun 17, 2025
5ff41b0
getting latest updates
ftclark3 Jun 17, 2025
6e308e2
Merge pull request #63 from ftclark3/fix-hbond
cabb99 Jun 17, 2025
fc228fd
cherry picking a commit from another branch.
ftclark3 Jan 22, 2025
9e44f72
cherry picking commit from another branch
ftclark3 Jan 22, 2025
dbb06d7
fixed mm_run.py and mm_analyze.py to handle extra arguments --periodi…
ftclark3 Jan 22, 2025
e9c6282
removed exclusions from excluded volume term cause those don't help w…
ftclark3 Feb 4, 2025
6344c29
added hydrogen bond function for sequence-independent helical term
ftclark3 Apr 24, 2025
6814c0f
Update hydrogenBondTerms.py
ftclark3 Jun 18, 2025
fdf6da7
add rama bonds at interface between fixed and non-fixed residues
ftclark3 Jun 18, 2025
bbee9da
added masks to arbitrarily reweight pair interaction energies in the …
ftclark3 Jun 18, 2025
44607e7
Merge pull request #65 from ftclark3/master
cabb99 Jun 18, 2025
1b77faa
improved periodic code
ftclark3 Jun 18, 2025
3401b3b
Merge pull request #64 from ftclark3/pbc_support
cabb99 Jun 18, 2025
a5dab40
refactored contact term to avoid nested if statements
ftclark3 Jun 18, 2025
7b1ddfc
more refactoring
ftclark3 Jun 18, 2025
fdc1c89
Merge branch 'master' into contact_mask
ftclark3 Jun 18, 2025
0a4e784
removed periodic argument from contact_term
ftclark3 Jun 18, 2025
717b21c
merging contact fix
ftclark3 Jun 18, 2025
e8e81d6
Merge pull request #66 from ftclark3/contact_mask
cabb99 Jun 18, 2025
e04f56e
syncing with carlos
ftclark3 Jun 18, 2025
6c6dd63
change oa.periodic to oa.periodic_box
ftclark3 Jun 19, 2025
e65d247
Merge pull request #67 from ftclark3/patch-11
cabb99 Jun 19, 2025
e918bcf
syncing with carlos
ftclark3 Jun 19, 2025
efa1317
remove periodic argument from excl_term call in forces_setup.py
ftclark3 Jun 19, 2025
a2b1c46
remove periodic argument from excl_term call in forces_setup.py
ftclark3 Jun 19, 2025
c659d06
MolSSI cookiecutter 1.11
cabb99 Jun 19, 2025
fda19ec
also removing excl_term periodic argument from test_energies.py
ftclark3 Jun 19, 2025
3d18f61
also removing excl_term from test_energies_supplemental.py
ftclark3 Jun 19, 2025
9aaf00b
Adds missing files from 1.11
cabb99 Jun 19, 2025
91c3c48
rename debye_huckel_term argument from self to oa
ftclark3 Jun 19, 2025
6c51910
Merge pull request #69 from ftclark3/patch-13
cabb99 Jun 19, 2025
85c4668
Merge pull request #68 from ftclark3/patch-12
cabb99 Jun 19, 2025
cf9b8ab
Merge branch 'vendor/molssi-cookiecutter' into docs
cabb99 Jun 19, 2025
d46fd4f
Merge branch 'master' of https://github.com/cabb99/openawsem into docs
cabb99 Jun 19, 2025
2d1537d
syncing with carlos
ftclark3 Jun 19, 2025
7fa21c7
Changes language to english
cabb99 Jun 19, 2025
567320b
Makes paths relative
cabb99 Jun 19, 2025
0050199
Adds getting started guide
cabb99 Jun 19, 2025
39ade1c
Adds some API
cabb99 Jun 19, 2025
fb983fb
Updates cr
cabb99 Jun 19, 2025
cd38fd5
Adds information from userguide from SI
cabb99 Jun 19, 2025
02a85b1
Updates readthedocs configuration requirement
cabb99 Jun 19, 2025
c12ed9b
Adds requirements
cabb99 Jun 19, 2025
4110aec
add options to turn off nu for the lammps beta terms and p_ap efficie…
ftclark3 Jun 21, 2025
6d4c849
syncing with remote, although local is the most up to date probably
ftclark3 Jun 21, 2025
784ff6f
Merge pull request #70 from ftclark3/master
cabb99 Jun 21, 2025
58e6684
fix incorrect transpose in Lambda matrices for the efficiency-optimiz…
ftclark3 Jun 22, 2025
1550630
added comment to p_ap term and rewrote a few lines to improve clarity…
ftclark3 Jun 22, 2025
8e1353b
added option to lammps/awsem-md p_ap potential to use only the antipa…
ftclark3 Jun 22, 2025
f899f18
updated efficiency-optimized p_ap terms to use CA-CA distances for do…
ftclark3 Jun 23, 2025
f8d4056
updated tests
ftclark3 Jun 23, 2025
27b054c
updated reference energies for efficiency-optimized p_ap test
ftclark3 Jun 23, 2025
191c592
updated reference energies for supplemental tests
ftclark3 Jun 23, 2025
e0938d5
added reference energies for supplemental tests
ftclark3 Jun 23, 2025
958ff31
comparison between efficiency optimized corrected potential and opena…
ftclark3 Jun 23, 2025
8d921af
added test to compare efficiency optimized corrected beta terms and p…
ftclark3 Jun 23, 2025
f29965d
Merge pull request #73 from ftclark3/fix-hbond-2
cabb99 Jun 23, 2025
25110cc
Merge branch 'master' into fix-hbond-3
ftclark3 Jun 23, 2025
70217a0
Merge pull request #75 from ftclark3/fix-hbond-3
cabb99 Jun 23, 2025
ae36994
getting latest changes
ftclark3 Jun 23, 2025
bb63d24
removed unnecessary test setup folder
ftclark3 Jun 24, 2025
2fbac73
Changes j-i to delta
cabb99 Jun 24, 2025
4bf0731
Calculates in_same_chain_i before the loop
cabb99 Jun 24, 2025
9eda97e
Moves adding bonds outside of the nested statements
cabb99 Jun 24, 2025
45ed03a
Moves check for i outside inner loop
cabb99 Jun 24, 2025
6c1a3c7
Removes some nested ifs
cabb99 Jun 24, 2025
2a55ccb
Removes nested ifs
cabb99 Jun 24, 2025
887e970
Makes parameters easier to understand
cabb99 Jun 24, 2025
0ade529
merging carlos edits
ftclark3 Jun 24, 2025
357c721
Merge pull request #11 from ftclark3/patch-pap
ftclark3 Jun 24, 2025
0f64123
Merge pull request #76 from ftclark3/master
cabb99 Jun 24, 2025
01752bb
fixed refactoring
ftclark3 Jun 26, 2025
094a4ba
Fixes logic to avoid double nested iteration
cabb99 Jun 26, 2025
b196e8c
Merge pull request #79 from ftclark3/master
cabb99 Jun 26, 2025
4a80f6f
append statedatareporters if continuing from checkpoint
ftclark3 Jun 27, 2025
22476ab
Update hydrogenBondTerms.py
ftclark3 Jun 30, 2025
6ddadf4
Merge pull request #81 from ftclark3/patch-15
cabb99 Jun 30, 2025
b8c1ead
Update parameter name
ftclark3 Jul 2, 2025
21e49dc
Merge pull request #82 from ftclark3/patch-16
cabb99 Jul 2, 2025
ea385ce
fixing typo
ftclark3 Jul 8, 2025
dffde26
automatically remove excess fragment memories
ftclark3 Aug 9, 2025
152bf82
stop writing PDB trajectory by default
ftclark3 Sep 20, 2025
97e685a
allow native.pdb to be written, but not trajectory
ftclark3 Sep 20, 2025
30d6e54
address concern about overwriting preexisting log file
ftclark3 Sep 20, 2025
4640a2d
Defines path only once
cabb99 Sep 20, 2025
aef600d
Merge pull request #87 from ftclark3/patch-19
cabb99 Sep 20, 2025
c2d6f92
Remove import subprocess
cabb99 Sep 20, 2025
c690eb0
Improves backup management
cabb99 Sep 20, 2025
ffa5be6
Replaces alltrue with all for numpy2.0 compatibility
cabb99 Sep 20, 2025
df3f3a8
Merge branch 'patch-14' of https://github.com/ftclark3/openawsem into…
cabb99 Sep 20, 2025
6af5f80
Fixes backup process
cabb99 Sep 20, 2025
9dd2a8d
Merge branch 'master' into patch-14
cabb99 Sep 20, 2025
612f0fe
Merge pull request #80 from ftclark3/patch-14
cabb99 Sep 20, 2025
634b662
Merge pull request #83 from ftclark3/patch-17
cabb99 Sep 21, 2025
542b884
Merge pull request #85 from ftclark3/patch-18
cabb99 Sep 21, 2025
dd28c31
parallelize initialization of HB potential, which can be slow for lar…
ftclark3 Sep 21, 2025
037c572
remove unused code
ftclark3 Sep 21, 2025
31e9280
Update HB info in user_guide.rst
ftclark3 Sep 21, 2025
36e6e0c
Add files via upload
ftclark3 Sep 21, 2025
ae17078
Update user_guide.rst
ftclark3 Sep 21, 2025
b65c0a5
added non-parallel option for beta HB setup
ftclark3 Sep 21, 2025
2c0b358
add HB implementation details
ftclark3 Sep 21, 2025
71f062c
Merge pull request #88 from ftclark3/parallelize_hb_init
cabb99 Sep 21, 2025
c23d2ac
getting rama updates that were interspersed with other updates on a d…
ftclark3 Sep 21, 2025
f803a4e
fix typo
ftclark3 Sep 21, 2025
0ec9c25
fix typo
ftclark3 Sep 21, 2025
cc8e546
fix typo
ftclark3 Sep 21, 2025
68e1ff5
Merge pull request #89 from ftclark3/patch-20
cabb99 Sep 21, 2025
bad0bad
clean up user_guide.rst
ftclark3 Sep 21, 2025
2b6b204
Merge pull request #90 from ftclark3/patch-21
cabb99 Sep 21, 2025
49e0a51
Update user_guide.rst
ftclark3 Sep 21, 2025
5734206
Merge pull request #91 from ftclark3/patch-22
cabb99 Sep 21, 2025
2b79d12
added better implementation of AM rama term
ftclark3 Sep 25, 2025
9f48299
removed rama AM clutter in basicTerms.py
ftclark3 Sep 25, 2025
20350bf
Merge pull request #92 from ftclark3/rama_am
cabb99 Sep 25, 2025
76f93bc
Merge branch 'master' of https://github.com/cabb99/openawsem into car…
ftclark3 Sep 30, 2025
7785d5c
Update hydrogenBondTerms.py with LAMMPS parameter info
ftclark3 Dec 31, 2025
588e7ad
Adds backward compatibility for sequences without fasta format.
cabb99 Mar 27, 2026
e331059
Adds test data
cabb99 Mar 27, 2026
d8a0606
Adds commands for all-atom reconstruction
cabb99 Mar 27, 2026
3b8890f
Updates readme
cabb99 Mar 27, 2026
16eb968
Merges with main
cabb99 Mar 27, 2026
355c654
Adds download links
cabb99 Mar 27, 2026
84576b9
Removes extra lines
cabb99 Mar 27, 2026
97bbfd2
Merge pull request #96 from ftclark3/patch-23
cabb99 Mar 27, 2026
52aa218
Merge pull request #98 from cabb99/atomistic_reconstruction
cabb99 Mar 27, 2026
6ada837
Update atomic masses for CA, O, and CB types
ftclark3 Apr 19, 2026
b247d24
Merge pull request #100 from ftclark3/patch-24
cabb99 Apr 19, 2026
deab949
Fixes membrane protein contact term bug due to energy_string construc…
cabb99 Apr 20, 2026
c204b5e
split Backbone energy test into Con, Chain, Chi, and Excluded terms. …
ftclark3 May 14, 2026
449dd2c
updated excl_term so that exclusions are always built in to the poten…
ftclark3 May 14, 2026
74c8987
updated tests for excluded volume cutoff of 4.5
ftclark3 May 14, 2026
8546bf9
added docstrings to clarify purpose of two test scripts
ftclark3 May 14, 2026
e7a68ad
added test to compare to lammps-calculated energies
ftclark3 May 14, 2026
f5423c9
cleaning up tests
ftclark3 May 14, 2026
8c05dc7
tiny change to excl term for possible performance improvement; mathem…
ftclark3 May 15, 2026
3c3b8f9
Pulling in Carlos Bueno
stevenluo22 May 22, 2026
26c32a5
Catching .* files
stevenluo22 May 22, 2026
f214ac8
Catching .* files 2
stevenluo22 May 22, 2026
2ade17d
Merge remote-tracking branch 'upstream/master' into carlos-master
stevenluo22 May 22, 2026
1a9abfc
Adding Constraints
stevenluo22 May 22, 2026
362e828
Adding import constraints file into functionTerms
stevenluo22 May 22, 2026
4b583cb
Merge pull request #102 from ftclark3/excl_fix
cabb99 May 22, 2026
c9646a8
Adds reference_energies for 2xov
cabb99 May 23, 2026
03adcc0
Adds 2xov information for tests
cabb99 May 23, 2026
95a9c09
Adds modified exclusion volume
cabb99 May 23, 2026
5ee7c34
Adds corrected_resid to Protein class
cabb99 May 23, 2026
f885936
Merges changes from PR 102
cabb99 May 23, 2026
0f323bb
sets default excl_term to finley's
cabb99 May 23, 2026
4283f80
Restore old group_constraint_by_distance; rename new group_constraint…
stevenluo22 May 27, 2026
3afca50
cleaning up
ftclark3 May 27, 2026
f64592c
Merge pull request #11 from ftclark3/merge-to-carlos-constraints
stevenluo22 May 27, 2026
4e3a20a
Update openawsem/functionTerms/constraints.py
cabb99 May 28, 2026
b9ea0b3
Merge pull request #103 from stevenluo22/merge-to-carlos-constraints
cabb99 May 28, 2026
d9b0cbd
Merge branch 'master' of https://github.com/cabb99/openawsem into car…
ftclark3 May 28, 2026
12946ee
added interface_q_term
May 28, 2026
bd0f203
Change default group parameters for group_constraint_by_distance
ftclark3 May 29, 2026
251713c
Merge pull request #105 from ftclark3/patch-25
cabb99 May 29, 2026
c33ab89
Merge pull request #104 from ftclark3/interface_q_term
cabb99 May 29, 2026
c20d272
Merge branch 'master' of https://github.com/cabb99/openawsem into car…
ftclark3 May 31, 2026
86789ec
remove ssweightFileName kwarg from pap_term_2
ftclark3 Jun 7, 2026
36b475c
Merge pull request #107 from ftclark3/patch-27
cabb99 Jun 8, 2026
7ba87cb
adds "rhetorically important" test system, NFKB
ftclark3 Jun 9, 2026
20e9229
fixed small rho calculation bug in contact_term for multichain systems
ftclark3 Jun 14, 2026
7dcbb19
Revert "Merge branch 'discard_structurally_mismatched_fragmems' into …
ftclark3 Jun 14, 2026
5a1094d
change fragment_length default in generate_fragment_memory from 9 to …
Jul 26, 2024
f6ee576
Merge pull request #109 from ftclark3/rho_chain_check
cabb99 Jun 14, 2026
b051d0a
Revert "Rho chain check"
cabb99 Jun 14, 2026
08a7685
Merge pull request #110 from cabb99/revert-109-rho_chain_check
cabb99 Jun 14, 2026
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
14 changes: 14 additions & 0 deletions .codecov.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Codecov configuration to make it a bit less noisy
coverage:
status:
patch: false
project:
default:
threshold: 50%
comment:
layout: "header"
require_changes: false
branches: null
behavior: default
flags: null
paths: null
13 changes: 7 additions & 6 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,13 @@
# Standard to msysgit
*.doc diff=astextplain
*.DOC diff=astextplain
*.docx diff=astextplain
*.DOCX diff=astextplain
*.dot diff=astextplain
*.DOT diff=astextplain
*.pdf diff=astextplain
*.docx diff=astextplain
*.DOCX diff=astextplain
*.dot diff=astextplain
*.DOT diff=astextplain
*.pdf diff=astextplain
*.PDF diff=astextplain
*.rtf diff=astextplain
*.RTF diff=astextplain
_version.py export-subst
openawsem/_version.py export-subst

42 changes: 42 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# How to contribute

We welcome contributions from external contributors, and this document
describes how to merge code changes into this openawsem.

## Getting Started

* Make sure you have a [GitHub account](https://github.com/signup/free).
* [Fork](https://help.github.com/articles/fork-a-repo/) this repository on GitHub.
* On your local machine,
[clone](https://help.github.com/articles/cloning-a-repository/) your fork of
the repository.

## Making Changes

* Add some really awesome code to your local fork. It's usually a [good
idea](http://blog.jasonmeridth.com/posts/do-not-issue-pull-requests-from-your-master-branch/)
to make changes on a
[branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/)
with the branch name relating to the feature you are going to add.
* When you are ready for others to examine and comment on your new feature,
navigate to your fork of openawsem on GitHub and open a [pull
request](https://help.github.com/articles/using-pull-requests/) (PR). Note that
after you launch a PR from one of your fork's branches, all
subsequent commits to that branch will be added to the open pull request
automatically. Each commit added to the PR will be validated for
mergability, compilation and test suite compliance; the results of these tests
will be visible on the PR page.
* If you're providing a new feature, you must add test cases and documentation.
* When the code is ready to go, make sure you run the test suite using pytest.
* When you're ready to be considered for merging, check the "Ready to go"
box on the PR page to let the openawsem devs know that the changes are complete.
The code will not be merged until this box is checked, the continuous
integration returns checkmarks,
and multiple core developers give "Approved" reviews.

# Additional Resources

* [General GitHub documentation](https://help.github.com/)
* [PR best practices](http://codeinthehole.com/writing/pull-requests-and-other-good-practices-for-teams-using-github/)
* [A guide to contributing to software packages](http://www.contribution-guide.org)
* [Thinkful PR example](http://www.thinkful.com/learn/github-pull-request-tutorial/#Time-to-Submit-Your-First-PR)
12 changes: 12 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## Description
Provide a brief description of the PR's purpose here.

## Todos
Notable points that this PR has either accomplished or will accomplish.
- [ ] TODO 1

## Questions
- [ ] Question1

## Status
- [ ] Ready to go
69 changes: 69 additions & 0 deletions .github/workflows/CI.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: CI

permissions:
contents: read

on:
# GitHub has started calling new repo's first branch "main" https://github.com/github/renaming
# The cookiecutter uses the "--initial-branch" flag when it runs git-init
push:
branches:
- "main"
pull_request:
branches:
- "main"
schedule:
# Weekly tests run on main by default:
# Scheduled workflows run on the latest commit on the default or base branch.
# (from https://help.github.com/en/actions/reference/events-that-trigger-workflows#scheduled-events-schedule)
- cron: "0 0 * * 0"

jobs:
test:
name: Test on ${{ matrix.os }}, Python ${{ matrix.python-version }}
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [macOS-latest, ubuntu-latest, windows-latest]
python-version: ["3.11", "3.12", "3.13"]

steps:
- uses: actions/checkout@v4

- name: Additional info about the build
shell: bash
run: |
uname -a
df -h
ulimit -a

# More info on options: https://github.com/marketplace/actions/setup-micromamba
- uses: mamba-org/setup-micromamba@v2
with:
environment-file: devtools/conda-envs/test_env.yaml
environment-name: test
condarc: |
channels:
- conda-forge
create-args: >-
python=${{ matrix.python-version }}

- name: Install package
# conda setup requires this special shell
shell: bash -l {0}
run: |
python -m pip install . --no-deps
micromamba list

- name: Run tests
# conda setup requires this special shell
shell: bash -l {0}
run: |
pytest -v --cov=openawsem --cov-report=xml --color=yes openawsem/tests/

- name: CodeCov
uses: codecov/codecov-action@v5
with:
files: ./coverage.xml
flags: unittests
name: codecov-${{ matrix.os }}-py${{ matrix.python-version }}
89 changes: 89 additions & 0 deletions .github/workflows/codeql.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
name: "CodeQL Advanced"

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
schedule:
- cron: '20 3 * * 1'

jobs:
analyze:
name: Analyze (${{ matrix.language }})
# Runner size impacts CodeQL analysis time. To learn more, please see:
# - https://gh.io/recommended-hardware-resources-for-running-codeql
# - https://gh.io/supported-runners-and-hardware-resources
# - https://gh.io/using-larger-runners (GitHub.com only)
# Consider using larger runners or machines with greater resources for possible analysis time improvements.
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
permissions:
# required for all workflows
security-events: write

# required to fetch internal or private CodeQL packs
packages: read

# only required for workflows in private repositories
actions: read
contents: read

strategy:
fail-fast: false
matrix:
include:
- language: actions
build-mode: none
- language: python
build-mode: none
# CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift'
# Use `c-cpp` to analyze code written in C, C++ or both
# Use 'java-kotlin' to analyze code written in Java, Kotlin or both
# Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
# To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
# see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
# If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
# your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
steps:
- name: Checkout repository
uses: actions/checkout@v4

# Add any setup steps before running the `github/codeql-action/init` action.
# This includes steps like installing compilers or runtimes (`actions/setup-node`
# or others). This is typically only required for manual builds.
# - name: Setup runtime (example)
# uses: actions/setup-example@v1

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v3
with:
languages: ${{ matrix.language }}
build-mode: ${{ matrix.build-mode }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.

# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# queries: security-extended,security-and-quality

# If the analyze step fails for one of the languages you are analyzing with
# "We were unable to automatically build your code", modify the matrix above
# to set the build mode to "manual" for that language. Then modify this step
# to build your code.
# ℹ️ Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
- if: matrix.build-mode == 'manual'
shell: bash
run: |
echo 'If you are using a "manual" build mode for one or more of the' \
'languages you are analyzing, replace this with the commands to build' \
'your code, for example:'
echo ' make bootstrap'
echo ' make release'
exit 1

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3
with:
category: "/language:${{matrix.language}}"
Loading