diff --git a/README.rst b/README.rst index 2a0f80f..386430e 100644 --- a/README.rst +++ b/README.rst @@ -101,10 +101,10 @@ displayed in a jupyter notebook: * a Crystal structure can be displayed in 3D: this requires the ``py3dmol`` and ``ipywidgets`` modules. See the notebook - ``examples/cystal_3d_widget.ipynb`` + ``docs/examples/cystal_3d_widget.ipynb`` * a PowderPattern can be displayed (and live-updated) if ``matplotlib`` and ``ipympl`` are installed. See the - notebook ``examples/cimetidine-structure-solution-powder.ipynb`` + notebook ``docs/examples/structure-solution-powder-cimetidine.ipynb`` Getting Started --------------- @@ -143,13 +143,15 @@ module with debug information and C-assertions checks :: Improvements and fixes are always appreciated. -Before contributing, please read our `Code of Conduct `_. +Before contributing, please read our `Code of Conduct `_. Contact ------- For more information on pyobjcryst please visit the project `web-page `_ or email Simon Billinge at sb2896@columbia.edu. +You can also contact Vincent Favre-Nicolin (favre@esrf.fr) if you are using pyobjcryst outside diffpy, e.g. to display structures in a notebook, refine powder patterns or solve structures using the global optimisation algorithms, etc.. + Acknowledgements ---------------- diff --git a/docs/source/conf.py b/docs/source/conf.py index 547675b..4dcd3af 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -343,7 +343,7 @@ def setup(app): "pyobjcryst Documentation", ab_authors, "pyobjcryst", - "One line description of project.", + "Python bindings to the ObjCryst++ library.", "Miscellaneous", ), ] diff --git a/docs/source/img/scikit-package-logo-text.png b/docs/source/img/scikit-package-logo-text.png deleted file mode 100644 index 823178d..0000000 Binary files a/docs/source/img/scikit-package-logo-text.png and /dev/null differ diff --git a/docs/source/index.rst b/docs/source/index.rst index f4f57a7..e6c6970 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -15,8 +15,7 @@ Authors `pyobjcryst` was written as part of the DANSE_ open-source project by Christopher Farrow, Pavol Juhás, and Simon J.L. Billinge. -The sources are maintained as a part of the DiffPy-CMI complex -modeling initiative at the Brookhaven National Laboratory. +The sources are maintained as a part of the `diffpy` project. The underlying library `ObjCryst++ `_ was developed by V. Favre-Nicolin as part of the development of the `Fox `_ software. diff --git a/docs/source/snippets/example-table.rst b/docs/source/snippets/example-table.rst deleted file mode 100644 index 7c4c11d..0000000 --- a/docs/source/snippets/example-table.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. list-table:: 5 levels of reusing/sharing code - :widths: 5 15 40 40 - :header-rows: 1 - - * - Level - - Name - - Scope - - How to setup - * - 1 - - ``function`` - - Reuse code in the single file. - - See Level 1 tutorial - * - 2 - - ``module`` - - Reuse code across files. - - See Level 2 tutorial - * - 3 - - ``workspace`` - - Reuse code across project folders. - - ``package create workspace`` - * - 4 - - ``system`` - - Reuse code across any files in the computer. - - ``package create system`` - * - 5 - - ``public`` - - Share code as publicly installable package. - - ``package create public`` diff --git a/pyproject.toml b/pyproject.toml index 8c34768..d10ba75 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -57,9 +57,6 @@ include = ["*"] # package names should match these glob patterns (["*"] by defa exclude = [] # exclude packages matching these glob patterns (empty by default) namespaces = false # to disable scanning PEP 420 namespaces (true by default) -[project.scripts] -pyobjcryst = "pyobjcryst.app:main" - [tool.setuptools.dynamic] dependencies = {file = ["requirements/pip.txt"]}