Skip to content

Commit

Permalink
Change README and setup.py to reflect naming change.
Browse files Browse the repository at this point in the history
  • Loading branch information
chazeon committed Jan 5, 2021
1 parent ba6730c commit 76b8d33
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 13 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,8 @@ The package can be installed with `pip` package manager.

### Command-line programs

The packge is shipped with the following command-line programs:

- **`qha-cij`** - Perform SAM-Cij calculation.
- **`qha-cij-static`** - Calculate elastic moduli and acoustic velocities.
- **`qha-cij-extract`** - Extract the value and create table for multiple variables at spcific P or T.
- **`qha-cij-fill`** - Fill non-zero Cij terms based on symmetry.
- **`qha-cij-modes`** - Plot interpolated mode frequency vs volume.
- **`qha-cij-plot`** - Plot SAM-Cij calculation results.

And is avaliable as sub-commands of the `cij` program:

After installation, the Cij program can be started by typing `cij` at your
command prompt:

```
Usage: cij [OPTIONS] COMMAND [ARGS]...
Expand All @@ -38,6 +29,16 @@ Commands:
run-static Calculate elastic moduli and acoustic velocities.
```

And are avaliable as standalone commands:

- **`cij-run`** - Perform SAM-Cij calculation.
- **`cij-run-static`** - Calculate elastic moduli and acoustic velocities.
- **`cij-extract`** - Extract the value and create table for multiple variables at spcific P or T.
- **`cij-fill`** - Fill non-zero Cij terms based on symmetry.
- **`cij-modes`** - Plot interpolated mode frequency vs volume.
- **`cij-plot`** - Plot SAM-Cij calculation results.


### SAM-Cij calculations with `qha-cij` or `cij run`

#### Configuration file
Expand Down Expand Up @@ -74,7 +75,7 @@ Options:

See [GitHub pages][1].

[1]: https://mineralscloud.github.io/qha-cij
[1]: https://mineralscloud.github.io/cij

## Author

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
description='High temperature thermal elasticity',
author='Chenxing Luo',
author_email='[email protected]',
url='https://github.com/MineralsCloud/qha-cij/',
url='https://github.com/MineralsCloud/cij/',
packages=find_packages(),
install_requires=[
"numpy >= 1.10.0",
Expand Down

0 comments on commit 76b8d33

Please sign in to comment.