diff --git a/License.txt b/License.txt new file mode 100644 index 0000000..3dcfab6 --- /dev/null +++ b/License.txt @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) [2023] [Fuzhan Rahmanian] + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.rst b/README.rst index e3656c5..0b928d5 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,7 @@ ARCANA ====== -.. image:: figures/logo/logo.png +.. image:: https://github.com/basf/ARCANA/blob/master/figures/logo/logo.png?raw=true :width: 200px :height: 200px :align: center @@ -22,7 +22,7 @@ The model provides robust multi-task prediction capabilities through its modular Documentation ------------- -The documentation for ARCANA is available at [ARCANADocs](https://basf.github.io/ARCANA/). +The documentation for ARCANA is available at `ARCANADocs `_. Installation @@ -32,7 +32,7 @@ A quick start can be achieved by downloading the pip packages by running this co .. code-block:: console - $ pip install arcana + $ pip install arcana-batt Quick Start ----------- @@ -129,7 +129,7 @@ Architecture ---------------------- Here is a diagram of the ARCANA architecture as a simplified UML class diagram. The classes contain the main methods and attributes of the model delineated before. -.. image:: figures/UML_Complete_unmodified.png +.. image:: https://github.com/basf/ARCANA/blob/master/figures/UML_Complete_unmodified.png?raw=true :width: 1084px :height: 626px :align: center @@ -138,6 +138,6 @@ Citation -------- If you use ARCANA in your research, please cite the following paper, where you can also find its theoretical background and full description: -Rahmanian, F. & Lee R. M., & Linzner, D. & Michel, K. & Merker, L. & Berkes, B. & Nuss, L. & Stein, H.S. (2023). Attention towards chemistry agnostic and explainable battery lifetime prediction. Available at: [ChemRxiv] (Accessed: [08.12.2023]). +Rahmanian, F. & Lee R. M., & Linzner, D. & Michel, K. & Merker, L. & Berkes, B. & Nuss, L. & Stein, H.S. (2023). Attention towards chemistry agnostic and explainable battery lifetime prediction. Available at: `ChemRxiv `_ (Accessed: [08.12.2023]). .. _ARCANA: https://github.com/basf/ARCANA \ No newline at end of file diff --git a/setup.py b/setup.py index 2b596c1..df95aed 100644 --- a/setup.py +++ b/setup.py @@ -44,8 +44,9 @@ long_description=readme + '\n\n' + history, include_package_data=True, keywords='arcana', - name='arcana', + name='arcana-batt', packages=find_packages(include=['arcana', 'arcana.*']), + package_data={'arcana\plots\styles': ['*.mplstyle']}, url="https://github.com/basf/ARCANA", version='1.0.0', zip_safe=False,