QCDevs commited on
Commit
5d37f51
·
1 Parent(s): 4812a27

Replace README.md with README_hf.md for Hugging Face

Browse files
Files changed (1) hide show
  1. README.md +8 -50
README.md CHANGED
@@ -1,50 +1,8 @@
1
- # The `selector` Library
2
-
3
- [![This project supports Python 3.7+](https://img.shields.io/badge/Python-3.7+-blue.svg)](https://python.org/downloads)
4
- [![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg)](https://opensource.org/licenses/)
5
- [![GitHub Actions CI Tox Status](https://github.com/theochem/Selector/actions/workflows/ci_tox.yml/badge.svg?branch=main)](https://github.com/theochem/Selector/actions/workflows/ci_tox.yml)
6
- [![codecov](https://codecov.io/gh/theochem/Selector/graph/badge.svg?token=0UJixrJfNJ)](https://codecov.io/gh/theochem/Selector)
7
-
8
- The `selector` library provides methods for selecting a diverse subset of a (molecular) dataset.
9
-
10
- Citation
11
- --------
12
-
13
- Please use the following citation in any publication using the `selector` library:
14
-
15
- ```md
16
- @article{
17
- }
18
- ```
19
-
20
-
21
- Installation
22
- ------------
23
-
24
- To install `selector` using the conda package management system, install
25
- [miniconda](https://conda.io/miniconda.html) or [anaconda](https://www.anaconda.com/download)
26
- first, and then:
27
-
28
- ```bash
29
- # Create and activate qcdevs conda environment (optional, but recommended)
30
- conda create -n qcdevs python=3.10
31
- conda activate qcdevs
32
-
33
- # Install the stable release
34
- # current conda release is not ready yet
35
- # conda install -c theochem qc-selector
36
-
37
- # install the development version
38
- pip install git+https://github.com/theochem/Selector.git
39
- ```
40
-
41
- To install `selector` with `pip`, you may want to create a
42
- [virtual environment](https://docs.python.org/3/tutorial/venv.html), and then:
43
-
44
-
45
- ```bash
46
- # Install the stable release.
47
- pip install qc-selector
48
- ```
49
-
50
- See https://selector.qcdevs.org for full details.
 
1
+ ---
2
+ title: QC-Selector
3
+ emoji: 🐳
4
+ colorFrom: purple
5
+ colorTo: gray
6
+ sdk: docker
7
+ app_port: 8501
8
+ ---