Skip to content

Commit

Permalink
dev(hansbug): update README && rename package's name
Browse files Browse the repository at this point in the history
  • Loading branch information
HansBug committed Sep 19, 2022
1 parent a6f9ad6 commit 423b721
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,14 @@

IGM (Intelligence Guidance Manager for AI).

The ultimate purpose of AI is to serve science (as ai4science does), so let's call it ``sci-igm``.

## Installation

You can simply install it with `pip` command line from the official PyPI site.

```shell
pip install igm
pip install sci-igm
```

Or install from latest source code as follows:
Expand All @@ -37,7 +39,7 @@ cd igm
pip install . --user
```

## Quick Start for HPO
## Quick Start for IGM

Here is a simple example to create a hello world project:

Expand Down
9 changes: 5 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@

from setuptools import find_packages

_package_name = "igm"
_MODULE_NAME = "igm"
_PACKAGE_NAME = 'sci-igm'

here = os.path.abspath(os.path.dirname(__file__))
meta = {}
with open(os.path.join(here, _package_name, 'config', 'meta.py'), 'r', 'utf-8') as f:
with open(os.path.join(here, _MODULE_NAME, 'config', 'meta.py'), 'r', 'utf-8') as f:
exec(f.read(), meta)


Expand All @@ -31,9 +32,9 @@ def _load_req(file: str):

setup(
# information
name=meta['__TITLE__'],
name=_PACKAGE_NAME,
version=meta['__VERSION__'],
packages=find_packages(include=(_package_name, "%s.*" % _package_name)),
packages=find_packages(include=(_MODULE_NAME, "%s.*" % _MODULE_NAME)),
package_data={
package_name: ['*.yaml', '*.yml']
for package_name in find_packages(include=('*'))
Expand Down

0 comments on commit 423b721

Please sign in to comment.