Skip to content

Commit ebbef70

Browse files
committed
update README.md and CONTRIBUTING.md
1 parent a73c487 commit ebbef70

File tree

2 files changed

+26
-10
lines changed

2 files changed

+26
-10
lines changed

python/pyabacus/CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Welcome to the `pyabacus` project! This document provides guidelines and instruc
99
<!-- toc -->
1010

1111
- [Project structure](#project-structure)
12-
* [Root CMake Configuration](#root-cmake-configuration)
13-
* [Module CMake Configuration](#module-cmake-configuration)
12+
- [Root CMake Configuration](#root-cmake-configuration)
13+
- [Module CMake Configuration](#module-cmake-configuration)
1414
- [Development Process](#development-process)
1515

1616
<!-- tocstop -->

python/pyabacus/README.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,34 @@
1-
Build Example: TwoCenterIntegral Section in ABACUS
1+
# pyabacus: a Python interface for the ABACUS package
22
==================================================
33

4-
An example project built with [pybind11](https://github.com/pybind/pybind11)
5-
and scikit-build-core. Python 3.7+ (see older commits for older versions of
6-
Python).
4+
`pyabacus` is a Python interface for the ABACUS package, which provides a high-level Python API for interacting with the `ABACUS` library.
75

8-
Installation
6+
This project is built using [pybind11](http://github.com/pybind/pybind11) and [scikit-build-core](https://scikit-build-core.readthedocs.io/), so you can easily build the project and use it in your Python environment.
7+
8+
Now, `pyabacus` provides the following modules:
9+
- `io`: a module for input/output in pyabacus.
10+
- `Cell`: a module for the cell structure to bridge `ModuleNAO` in python module with users' input.
11+
- `ModuleBase`: a module for basic math functions.
12+
- `ModuleNAO`: a module for numerical atomic orbitals (NAO).
13+
- `hsolver`: a module for solving the Hamiltonian.
14+
15+
<!-- toc -->
16+
17+
- [Installation](#installation)
18+
- [CI Examples](#ci-examples)
19+
- [License](#license)
20+
- [Test call](#test-call)
21+
22+
<!-- tocstop -->
23+
24+
## Installation
925
------------
1026

1127
- Create and activate a new conda env, e.g. `conda create -n myenv python=3.8 & conda activate myenv`.
1228
- Clone ABACUS main repository and `cd abacus-develop/python/pyabacus`.
1329
- Build pyabacus by `pip install -v .` or install test dependencies & build pyabacus by `pip install .[test]`. (Use `pip install -v .[test] -i https://pypi.tuna.tsinghua.edu.cn/simple` to accelerate installation process.)
1430

15-
CI Examples
31+
## CI Examples
1632
-----------
1733

1834
There are examples for CI in `.github/workflows`. A simple way to produces
@@ -71,14 +87,14 @@ eigenvalues difference:
7187
-8.94295749e-12 4.71351846e-11 5.39378986e-10 1.97244101e-08]
7288
```
7389

74-
License
90+
## License
7591
-------
7692

7793
pybind11 is provided under a BSD-style license that can be found in the LICENSE
7894
file. By using, distributing, or contributing to this project, you agree to the
7995
terms and conditions of this license.
8096

81-
Test call
97+
## Test call
8298
---------
8399

84100
```python

0 commit comments

Comments
 (0)