diff --git a/README.md b/README.md index 8b9f88fc..b3d4e93d 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,8 @@ [![Supported Python Versions](https://img.shields.io/pypi/pyversions/erlab)](https://pypi.org/project/erlab/) [![PyPi](https://img.shields.io/pypi/v/erlab.svg)](https://pypi.org/project/erlab/) [![Workflow Status](https://github.com/kmnhan/erlabpy/actions/workflows/release.yml/badge.svg)](https://github.com/kmnhan/erlabpy/actions/workflows/release.yml) -[![Documentation Status](https://readthedocs.org/projects/erlabpy/badge/?version=latest)](https://erlabpy.readthedocs.io/en/latest/) +[![Documentation Status](https://readthedocs.org/projects/erlabpy/badge/)](https://erlabpy.readthedocs.io/) +[![License](https://img.shields.io/pypi/l/erlab)](https://pypi.org/project/erlab/) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) Welcome to *ERLabPy*, a Python library designed to simplify and streamline the @@ -17,8 +18,8 @@ spectroscopy (ARPES) experiments. existing scientific Python workflows. It is also designed to be extensible, allowing users to easily add custom functionality and analysis tools. -*ERLabPy* is developed and maintained by the Electronic structure Research -Laboratory (ERLab) at Korea Advanced Institute of Science and Technology +*ERLabPy* is developed and maintained by the electronic structure research +laboratory at Korea Advanced Institute of Science and Technology (KAIST). ## Features @@ -50,11 +51,11 @@ Try enabling/disabling dark mode in your browser! ## Documentation -The full documentation for ERLabPy is available at [Read the Docs](https://erlabpy.readthedocs.io/en/latest/). +The full documentation for ERLabPy is available at [Read the Docs](https://erlabpy.readthedocs.io/). ## Getting Started -To get started with ERLab, follow the [installation instructions](https://erlabpy.readthedocs.io/en/latest/readme.html). +To get started with ERLab, follow the [installation instructions](https://erlabpy.readthedocs.io/en/stable/getting-started.html). Then, you can import the `erlab` module in your Python scripts and start analyzing your data. @@ -65,7 +66,7 @@ import erlab ## Contributing Contributions are welcome! Please open an issue or pull request if you have any -suggestions or improvements. +suggestions or improvements. For more information on contributing, see the [development guide](https://erlabpy.readthedocs.io/en/stable/development.html). ## License diff --git a/environment.yml b/environment.yml index bccc3c6d..29707ca4 100644 --- a/environment.yml +++ b/environment.yml @@ -2,7 +2,7 @@ name: erlab channels: - conda-forge dependencies: - - python>=3.10 + - python>=3.11 - ipython - pip>=19.3 - setuptools @@ -53,6 +53,5 @@ dependencies: - pip: - pyqt6>=6.2.2 - csaps - - -e git+https://github.com/kmnhan/igor2.git#egg=igor2 - - -e git+https://github.com/kmnhan/igorpy.git#egg=igor - - -e git+https://github.com/kmnhan/arpes.git#egg=arpes \ No newline at end of file + - igor2 @ git+https://github.com/kmnhan/igor2@master + - arpes @ git+https://github.com/kmnhan/arpes@master \ No newline at end of file diff --git a/environment_apple.yml b/environment_apple.yml index 7a502c7f..7b73aca3 100644 --- a/environment_apple.yml +++ b/environment_apple.yml @@ -2,7 +2,7 @@ name: erlab channels: - conda-forge dependencies: - - python>=3.10 + - python>=3.11 - ipython - pip>=19.3 - setuptools @@ -57,6 +57,5 @@ dependencies: - pip: - pyqt6>=6.2.2 - csaps - - -e git+https://github.com/kmnhan/igor2.git#egg=igor2 - - -e git+https://github.com/kmnhan/igorpy.git#egg=igor - - -e git+https://github.com/kmnhan/arpes.git#egg=arpes \ No newline at end of file + - igor2 @ git+https://github.com/kmnhan/igor2@master + - arpes @ git+https://github.com/kmnhan/arpes@master \ No newline at end of file diff --git a/environment_nogit.yml b/environment_nogit.yml index 8b3a17bd..62111346 100644 --- a/environment_nogit.yml +++ b/environment_nogit.yml @@ -2,7 +2,7 @@ name: erlab channels: - conda-forge dependencies: - - python>=3.10 + - python>=3.11 - ipython - pip>=19.3 - setuptools diff --git a/environment_nogit_mkl.yml b/environment_nogit_mkl.yml index 41e8fb0b..c9de7cfa 100644 --- a/environment_nogit_mkl.yml +++ b/environment_nogit_mkl.yml @@ -2,7 +2,7 @@ name: erlab channels: - conda-forge dependencies: - - python>=3.10 + - python>=3.11 - ipython - pip>=19.3 - setuptools diff --git a/pyproject.toml b/pyproject.toml index 51974524..5340f7a6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -46,12 +46,12 @@ dependencies = [ "pyqtgraph>=0.13.1", "qtawesome", "superqt", - 'importlib-metadata; python_version>="3.10"', + 'importlib-metadata; python_version>="3.11"', ] dynamic = ["version"] [project.urls] -Documentation = "https://erlabpy.readthedocs.io/en/latest/" +Documentation = "https://erlabpy.readthedocs.io" Repository = "https://github.com/kmnhan/erlabpy.git" Issues = "https://github.com/kmnhan/erlabpy/issues" Changelog = "https://github.com/kmnhan/erlabpy/blob/main/CHANGELOG.md"