-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
44d1cf3
commit 07bef34
Showing
1 changed file
with
16 additions
and
66 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,81 +1,31 @@ | ||
| # [![License][50]][51] [![Release][32]][33] [![Downloads][70]][71] [![CI Build][20]][21] | ||
| <img src="https://raw.githubusercontent.com/EasyScience/EasyCrystallography/refs/heads/master/resources/images/ec_logo.svg" height="65"> | ||
|
|
||
| [![CodeFactor][83]][84] [![Codecov][85]][86] | ||
| [![Lines of code][81]](<>) [![Total lines][80]](<>) [![Files][82]](<>) | ||
| EasyCrystallography is a library used to generate and manipulate crystal structures within the [EasyScience](https://github.com/EasyScience) framework. | ||
|
|
||
| <img height="80"><img src="https://raw.githubusercontent.com/easyScience/easyCrystallography/develop/resources/images/ec_logo.svg" height="65"> | ||
| ## Installation | ||
|
|
||
| **EasyCrystallography** is a library that can be used for the generation and manipulation of crystal structures. | ||
| The latest release of EasyCrystallography can be installed with pip from PyPi: | ||
|
|
||
| ## Install | ||
| ``` | ||
| pip install easycrystallography | ||
| ``` | ||
|
|
||
| **EasyCrystallography** can be downloaded using pip: | ||
| Installing an unreleased version is not recommended and should only be done for testing purposes. Here is an example of how to install EasyCrystallography directly from a GitHub repository, e.g. from the develop branch: | ||
|
|
||
| ```pip install easycrystallography``` | ||
|
|
||
| Or direct from the repository: | ||
|
|
||
| ```pip install https://github.com/EasyScience/EasyCrystallography``` | ||
|
|
||
| ## Test | ||
|
|
||
| After installation, launch the test suite: | ||
|
|
||
| ```python -m pytest``` | ||
|
|
||
| [//]: # (## Documentation) | ||
|
|
||
| [//]: # () | ||
| [//]: # (Documentation can be found at:) | ||
|
|
||
| [//]: # () | ||
| [//]: # ([https://easyScience.github.io/easyCore](https://easyScience.github.io/easyCore)) | ||
| ``` | ||
| pip install git+https://github.com/EasyScience/EasyCrystallography@develop | ||
| ``` | ||
|
|
||
| ## Contributing | ||
| We absolutely welcome contributions. **easyCore** is maintained by the ESS and on a volunteer basis and thus we need to foster a community that can support user questions and develop new features to make this software a useful tool for all users while encouraging every member of the community to share their ideas. | ||
|
|
||
| ## License | ||
| While **easyCore** is under the BSD-3 license | ||
|
|
||
| <!---CI Build Status---> | ||
|
|
||
| [20]: https://github.com/EasyScience/EasyCrystallography/workflows/CI%20using%20pip/badge.svg | ||
|
|
||
| [21]: https://github.com/EasyScience/EasyCrystallography/actions | ||
|
|
||
|
|
||
| <!---Release---> | ||
| We absolutely welcome contributions, and our goal is for EasyCrystallography to be a community-driven open source project developed by a diverse group of contributors. | ||
|
|
||
| [32]: https://img.shields.io/pypi/v/easysciencecore?color=green | ||
| EasyCrystallography is currently maintained by [European Spallation Source ERIC](https://ess.eu), Sweden. | ||
|
|
||
| [33]: https://pypi.org/project/easyCrystallography | ||
|
|
||
| If you are interested in contributing directly to the code, please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests. | ||
|
|
||
| <!---License---> | ||
|
|
||
| [50]: https://img.shields.io/github/license/easyScience/easyCrystallography.svg | ||
|
|
||
| [51]: https://github.com/EasyScience/EasyCrystallography/blob/master/LICENSE.md | ||
|
|
||
|
|
||
| <!---Downloads---> | ||
|
|
||
| [70]: https://img.shields.io/pypi/dm/easyCrystallography.svg | ||
|
|
||
| [71]: https://pypi.org/project/easyCrystallography | ||
|
|
||
| <!---Code statistics---> | ||
|
|
||
| [80]: https://tokei.rs/b1/github/easyScience/easyCrystallography | ||
|
|
||
| [81]: https://tokei.rs/b1/github/easyScience/easyCrystallography?category=code | ||
|
|
||
| [82]: https://tokei.rs/b1/github/easyScience/easyCrystallography?category=files | ||
|
|
||
| [83]: https://www.codefactor.io/repository/github/easyscience/easyCrystallography/badge | ||
|
|
||
| [84]: https://www.codefactor.io/repository/github/easyscience/easyCrystallography | ||
| ## License | ||
|
|
||
| [85]: https://img.shields.io/codecov/c/github/easyScience/easyCrystallography?color=green | ||
| EasyCrystallography is licensed under the [BSD-3 license](LICENSE). | ||
|
|
||
| [86]: https://app.codecov.io/gh/easyScience/easyCrystallography/ |