diff --git a/README.md b/README.md index 3d702a857..74aae576f 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,31 @@ -## Getting Started -. +# Systolic CNN AcceLErator Simulator (SCALE Sim) v2 -### 30 seconds to SCALE-Sim! +SCALE Sim is a simulator for systolic array based accelerators for Convolution, Feed Forward, and any layer that uses GEMMs. +This is a refreshed version of the simulator with feature enhancements, restructured code to aid feature additions, and ease of distribution. -Getting started is simple! SCALE-Sim is completely written in python. At the moment, it has dependencies on the following python packages. Make sure you have them in your environment. +The previous version of the simulator can be found [here](https://github.com/ARM-software/SCALE-Sim). -* os -* subprocess -* numpy -* math -* configparser -* tqdm +## Getting started in 30 seconds +### *Installing the package* + +Getting started is simple! SCALE-Sim is completely written in python and is available both as a package and could be run from source. + +You can install SCALE-Sim in your environment using the following command + +```$ pip3 install scalesim``` + +Alternatively you can install the package from the source as well + +```$ python3 setup.py install``` + +### *Launching a run* + +SCALE-Sim can be run by using the ```scale.py``` script from the repository and providing the paths to the architecture configuration, and the topology descriptor csv file. + +```$ python3 scale.py -c -t ``` + +Try it now in the google colab notebook (**TBD**) ### Custom Experiment diff --git a/dist/scalesim-2.0-py3-none-any.whl b/dist/scalesim-2.0-py3-none-any.whl new file mode 100644 index 000000000..d5240dd6c Binary files /dev/null and b/dist/scalesim-2.0-py3-none-any.whl differ diff --git a/dist/scalesim-2.0.tar.gz b/dist/scalesim-2.0.tar.gz new file mode 100644 index 000000000..fb22ca9b3 Binary files /dev/null and b/dist/scalesim-2.0.tar.gz differ diff --git a/setup.py b/setup.py new file mode 100644 index 000000000..3e3346f24 --- /dev/null +++ b/setup.py @@ -0,0 +1,37 @@ +import pathlib +from setuptools import setup, find_packages + +# The directory containing this file +HERE = pathlib.Path(__file__).parent + +# The text of the README file +README = (HERE / "README.md").read_text() + +setup( + name='scalesim', + version='2.0', + description='Systolic CNN AcceLerator Simulator', + long_description=README, + long_description_content_type="text/markdown", + author='anands09, jmj, tushar, vnadella', + author_email='anandsamajdar@gatech.edu', + maintainer='SynergyLab, GT', + maintainer_email='anandsamajdar@gatech.edu', + url='https://github.com/scalesim-project/scale-sim-v2', + license="MIT", + packages=find_packages(), + include_package_data=False, # The include_package_data argument controls whether non-code files are copied when your package is installed + install_requires=["numpy","configparser","absl-py", "tqdm"], + classifiers=[ + 'Development Status :: 3 - Alpha', + 'Intended Audience :: Developers', + 'Intended Audience :: Education', + 'Intended Audience :: Science/Research', + 'License :: OSI Approved :: MIT License', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: Implementation :: PyPy', + 'Topic :: Scientific/Engineering' + ] +)