Skip to content

Commit

Permalink
add contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SunyongKwon committed Jul 31, 2024
1 parent 638cdc0 commit 7c1608b
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 23 deletions.
12 changes: 0 additions & 12 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,5 @@
# Contributor Covenant Code of Conduct

## Contributing

Contributing to Equilipy is easy: just open a
[pull request](https://help.github.com/articles/using-pull-requests/).
Make `main` the destination branch on the [Equilipy
repository](https://github.com/ORNL/Equilipy) and allow edits from
maintainers.

Your pull request must work with all current Equilipy tutorial examples
and be reviewed by at least one Equilipy developer.


## Our Standards

We as contributors and maintainers pledge to making participation in our project and
Expand Down
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

## Contributing

Contributing to Equilipy is easy: just open a
[pull request](https://help.github.com/articles/using-pull-requests/).
Make `main` the destination branch on the [Equilipy
repository](https://github.com/ORNL/Equilipy) and allow edits from
maintainers.

Your pull request must work with all current Equilipy tutorial examples
and be reviewed by at least one Equilipy developer.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ The following features are currently available.

For details, check out the example directory and [Features and Examples](https://ornl.github.io/Equilipy/features.html)

## Contributing
We encourage you to contribute to Equilipy. Please see [contributing guidelines](CONTRIBUTING.md).

## Additional note
Examples in Equilipy uses `polars` dataframe for fast data processing. In particular, example 3 requires `fastexcel` as the optional dependancy in `polars`.
Expand Down
10 changes: 5 additions & 5 deletions example/Example05_ScheilCooling.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@
# Step 2: Set input data
system=['Al','Cu','Mg','Si']
NTP = dict({
'T':1000,
'T':900,
'P': 1,
'Al':0.75,
'Cu': 0.05,
'Mg':0.1,
'Si': 0.1})
'Al':0.89260,
'Cu': 0.01745,
'Mg':0.00114,
'Si': 0.0881})

# Step 3: Calculate Scheil cooling based on LIQUID as target phase
TargetPhase='LIQUID'
Expand Down
12 changes: 6 additions & 6 deletions example/Example06_ScheilCooling_PhaseSelection.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@
#Set input data

NTP = dict({
'T':1000,
'T':900,
'P': 1,
'Al':0.8,
'Cu': 0.05,
'Mg':0.1,
'Si': 0.05})
'Al':0.89260,
'Cu': 0.01745,
'Mg':0.00114,
'Si': 0.0881})
#Phase selection
PhasesAll=eq.list_phases(DB,list(NTP.keys())[2:])
phases = ['LIQUID','FCC_A1','MG2SI(s)']
phases = [x for x in PhasesAll if 'FCC_A1' not in x]

# Calculate Scheil cooling
res=eq.scheil_cooling('LIQUID',DB,NTP,dT=10,ListOfPhases=phases)
Expand Down

0 comments on commit 7c1608b

Please sign in to comment.