diff --git a/AUTHORS.md b/AUTHORS.md deleted file mode 100644 index ee1b5d79..00000000 --- a/AUTHORS.md +++ /dev/null @@ -1,9 +0,0 @@ -# Authors - -## Main developer - -Matteo Bunino \<[matteo.bunino@cern.ch](mailto:matteo.bunino@cern.ch)\> - -## Contributors - -[All contributors](https://github.com/interTwin-eu/T6.5-AI-and-ML/graphs/contributors) diff --git a/CITATION.cff b/CITATION.cff index 5dd1db02..8751f62b 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -7,12 +7,67 @@ message: >- If you use this software, please cite it using the metadata from this file. type: software + +# The oder reflects the contributions to the repository to date +# Also including supervisors who attended the meetings authors: - given-names: Matteo family-names: Bunino email: matteo.bunino@cern.ch affiliation: CERN orcid: 'https://orcid.org/0009-0008-5100-9300' + - given-names: Rakesh + family-names: Sarma + email: r.sarma@fz-juelich.de + affiliation: FZ Jülich + - given-names: Jarl Sondre + family-names: Sæther + email: jarl.sondre.saether@cern.ch + affiliation: CERN + - given-names: Anna Elisa + family-names: Lappe + email: anna.elisa.lappe@cern.ch + affiliation: CERN + - given-names: Kalliopi + family-names: Tsolaki + email: kalliopi.tsolaki@cern.ch + affiliation: CERN + - given-names: Killian + family-names: Verder + email: killian.verder@cern.ch + affiliation: CERN + - given-names: Henry + family-names: Mutegeki + email: henry.mutegeki@cern.ch + affiliation: CERN + - given-names: Roman + family-names: Machacek + email: roman.machacek@cern.ch + affiliation: CERN + - given-names: Alexander + family-names: Zoechbauer + email: alexander.zoechbauer@cern.ch + affiliation: CERN + - given-names: Mario + family-names: Ruettgers + email: m.ruettgers@fz-juelich.de + affiliation: FZ Jülich + - given-names: Ilaria + family-names: Luise + email: ilaria.luise@cern.ch + affiliation: CERN + - given-names: Eric + family-names: Wulff + email: eric.wulff@cern.ch + affiliation: CERN + - given-names: Maria + family-names: Girone + email: maria.girone@cern.ch + affiliation: CERN + - given-names: Andreas + family-names: Lintermann + email: a.lintermann@fz-juelich.de + affiliation: FZ Jülich repository-code: 'https://github.com/interTwin-eu/itwinai' url: 'https://itwinai.readthedocs.io/' abstract: AI on cloud and HPC made simple for science diff --git a/LICENSE b/LICENSE index 3899f9e5..5c4ad861 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,201 @@ -MIT License - -Copyright (c) 2023 interTwin Community - -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. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2023 CERN + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 00000000..5b9e2dd0 --- /dev/null +++ b/MAINTAINERS.md @@ -0,0 +1,19 @@ +# Authors + +## Mantainers + +- Matteo Bunino - CERN - matteo.bunino\cern.ch +- Jarl Sondre Saether - CERN - jarl.sondre.saether\cern.ch +- Anna Elisa Lappe - CERN - anna.elisa.lappe\cern.ch +- Rakesh Sarma - FZJ - r.sarma\fz-juelich.de + +## Contributors + +- Kalliopi Tsolaki - CERN - kalliopi.tsolaki\cern.ch +- Killian Verder - CERN - killian.verder\cern.ch +- Henry Mutegeki - CERN - henry.mutegeki\cern.ch +- Roman Machacek - CERN - roman.machacek\cern.ch +- Alexander Zoechbauer - CERN - alexander.zoechbauer\cern.ch +- Mario Ruettgers - FZJ - m.ruettgers\fz-juelich.de + +[Full contributors list](https://github.com/interTwin-eu/itwinai/graphs/contributors) diff --git a/README.md b/README.md index 778a15ae..942d63c0 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,12 @@ ![itwinai Logo](./docs/images/icon-itwinai-orange-black-subtitle.png) -`itwinai` is a powerful Python toolkit designed to help scientists and researchers streamline AI and machine learning +`itwinai` is a Python toolkit designed to help scientists and researchers streamline AI and machine learning workflows, specifically for digital twin applications. It provides easy-to-use tools for distributed training, hyper-parameter optimization on HPC systems, and integrated ML logging, reducing engineering overhead and accelerating -research. Developed primarily by CERN, `itwinai` supports modular and reusable ML workflows, with -the flexibility to be extended through third-party plugins, empowering AI-driven scientific research in digital twins. +research. Developed primarily by CERN, in collaboration with Forschungszentrum Jülich (FZJ), `itwinai` supports modular +and reusable ML workflows, with the flexibility to be extended through third-party plugins, empowering AI-driven scientific +research in digital twins. See the latest version of our docs [here](https://itwinai.readthedocs.io/). diff --git a/docs/conf.py b/docs/conf.py index 32537332..1efe3ac8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -27,11 +27,11 @@ sys.path.insert(0, os.path.abspath("../src")) sys.path.insert(0, os.path.abspath("../images")) -project = "itwinai" -copyright = "2024, Matteo Bunino on behalf of CERN" -author = "Matteo Bunino" -version = "0.2" # short version -release = "0.2.2" # full version +project = 'itwinai' +copyright = '2024, interTwin collaboration' +# author = 'Matteo Bunino' +# version = '0.2' # short version +# release = '0.2.2' # full version # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration diff --git a/docs/index.rst b/docs/index.rst index 2b0b3d37..84d0d12e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,9 +19,12 @@ experiment management. Moreover, the toolkit is designed with extensibility in mind, allowing third-party developers to build and integrate their own plugins, enhancing the flexibility and adaptability of the platform. -``itwinai`` is primarily developed by `Matteo Bunino `_ from `CERN `_, in -collaboration with the `interTwin `_ -project, which aims to advance the use of digital twins in scientific research. +``itwinai`` is an open-source Python library primarily developed by CERN, in collaboration with Forschungszentrum Jülich (FZJ). +As the primary contributor, CERN will retain administrative rights to the repository during and after the interTwin project, +except in cases where CERN is unable to maintain it. + +The library also benefits from contributions by members of the interTwin collaboration. +For a complete list of contributors, visit the `GitHub contributors page `_. How to Read the Docs