Running from source

The implementation is in Python 3.6 – 3.9, and is intended for Windows (recent), MacOS X 10.9-11, Unix or Linux. The standard installation includes both desktop GUI and a localhost RESTful web server. Sources for the standard version are on gitHub/arelle Arelle project (master branch) and (where applicable) EdgarRenderer project.

  1. Download Arelle sources zip file (from GitHub) and unzip somewhere convenient.  If applicable also SEC’s EdgarRenderer should be unzipped to arelle/plugin/EdgarRenderer.

Windows

    1. You may need to install Python. Download from python.org, download latest Python 3 release, Windows 64 bit installer.
    2. Add in libraries needed using pip: To a shell window enter
      pip3 install lxml pg8000 pymysql numpy rdflib isodate regex aniso8601 graphviz holidays openpyxl Pillow pycountry cherrypy cheroot python-dateutil pytz tornado pyparsing matplotlib pyodbc
    3. Start arelle by 
      python3 arelleGUI.pyw

Mac

    1. You may need to install Python. Download from python.org, download latest Python 3 release, Intel or Universal (Intel/M1) installer.  Big Sur or Mac M1 require Python ≥ 3.9.1.
    2. Add in libraries needed using pip: To a terminal window enter
      pip3 install lxml pg8000 pymysql numpy rdflib isodate regex aniso8601 graphviz holidays openpyxl Pillow pycountry cherrypy cheroot python-dateutil pytz tornado pyparsing matplotlib pyodbc
    3. Start arelle in a terminal window by 
      python3 arelleGUI.pyw

Server (Google App Engine or Unix)

Source

Server installation may be based on the Python 3.6 – 3.9 source code from gitHub, or for Google App Engine, an (old) pre-configured Python 2.7 zip file is available on the download page. Server installation support is available on a consulting basis.

RedHat and Ubuntu setup

Use MacOS setup.  On RedHat, install their most recent python 3.  On Ubuntu Python is most likely installed, but the libraries may need to be added.

 

Comments are closed.