Update README.md

pyscal · Apr 14, 2024 · ff819b7 · ff819b7
1 parent f98b396
commit ff819b7
Showing 1 changed file with 6 additions and 57 deletions.
diff --git a/README.md b/README.md
@@ -1,65 +1,14 @@
-# pyscal_rdf
+# atomRDF
 
-`pyscal_rdf` is a python tool for ontology-based creation, manipulation, and quering of structures. `pyscal_rdf` uses the [Computational Material Sample Ontology (CMSO)](https://github.com/Materials-Data-Science-and-Informatics/cmso-ontology). 
-
-The package is currently under activate development and could be  unstable .
-
-You can try `pyscal_rdf`  here:
-
-| Jupyter notebook  | GUI |
-|-------------------|-----|
-| [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pyscal/pyscal_rdf/HEAD?labpath=example.ipynb)  | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pyscal/pyscal_rdf/voila?urlpath=voila%2Frender%2Fexample_gui.ipynb)  |
-
-## Installation
-
-### Supported operating systems
-
-`pyscal_rdf` can be installed on Linux and Mac OS based systems. On Windows systems, it is recommended to use  [Windows subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install).
-
-### Using pip
-
-```
-pip install pyscal-rdf
-```
-### Using conda
-
-```
-conda install -c conda-forge pyscal-rdf
-```
+> [!NOTE]
+> `atomRDF` was previously called `pyscal-rdf`. 
 
 
-### Building from the repository
+`atomRDF` is a python tool for ontology-based creation, manipulation, and quering of structures. `atomRDF` uses the [Computational Material Sample Ontology (CMSO)](https://github.com/Materials-Data-Science-and-Informatics/cmso-ontology). 
 
-We strongly recommend creating a conda environment for the installation. To see how you can install conda see [here](https://docs.conda.io/projects/conda/en/latest/user-guide/install/).
-
-Once a conda distribution is available, the following steps will help set up an environment to use `pyscal_rdf`. First step is to clone the repository.
-
-```
-git clone https://github.com/pyscal/pyscal_rdf.git
-```
-
-After cloning, an environment can be created from the included file-
-
-```
-cd pyscal_rdf
-conda env create -f environment.yml
-```
-
-This will install the necessary packages and create an environment called rdf. It can be activated by,
-
-```
-conda activate rdf
-```
-
-then, install `pyscal_rdf` using,
-
-```
-pip install .
-```
-
-## Using `pyscal_rdf`
+The package is currently under activate development and could be  unstable .
 
-Coming soon..
+More details coming soon...
 
 
 ## Acknowledgements