Step by Step Installation Instructions

NAACCR edited this page Oct 23, 2017 · 27 revisions
Clone this wiki locally

Getting Python

Windows

To download Python, visit http://www.python.org/getit/ in a new window. Download the Python 3.x.x Windows (x86/x86-64) MSI Installer. If you do not know if your machine is 32-bit (x86) or 64-bit (x86-64), the 32-bit (x86) version will work fine for both. Do not download an alpha or beta version as these may be unstable.

Once you have downloaded the installer, open it. Leave the installation location as the default but make sure to select the option to "Add python.exe to Path" by clicking the red X next to it and choosing "Will be installed on local hard drive."

Add python.exe to Path

When the installation is complete, see the section below called Getting vol2_dd_export.

Mac OS

To download Python, visit http://www.python.org/getit/ in a new window. Download Python 3.x.x Mac OS X (architecture) Installer (version). Select the appropriate installer based on your version of Mac OS. Do not download an alpha or beta version as these may be unstable.

Once you have downloaded the installer, click on the .dmg file to open it. This will open a folder in Finder. In that folder, double-click on Python.mpkg to launch the installer. During the installation, leave all settings as their defaults except when you come to the "Installation Type" page. On this page, click the "Customize" button and select the option for "Shell Profile Updater" and then click install.

When the installation is complete, see the section below called Getting vol2_dd_export.

Linux

Python 3.x is available in the repositories of most major Linux distributions. You will need the following packages to run this script:

python3 python3-tk

The installation instructions for different distributions of Linux will vary but most can be installed from the terminal with your package manager in a similar manner to the following example (using APT):

apt-get install python3 python3-tk

This may require elevated privileges using sudo. When the installation is complete, see the section below called Getting vol2_dd_export.

Getting vol2_dd_export

Downloading

There are three ways to get the vol2_dd_export script:

  1. Download from the NAACCR Website
    Visit https://www.naaccr.org/data-standards-data-dictionary/ which contains a link to a zipped version of the script and all associated files. Once it has been downloaded, see the section below called Extracting.

  2. Download from Github
    Right-click on the link "vol2_dd_export" at the top of this page and choose "Open in New Tab" or "Open in New Window." In that window, click "x Release(s)" in the bar at the top GitHub Top Bar - Releases and then click the green "vol2_dd_export.zip" button next to the latest release. Once it has been downloaded, see the section below called Extracting.

  3. Clone the Github Repository (ADVANCED)
    If you have git installed on your system, you can clone the repository by issuing the command (in a terminal or command prompt): git clone https://github.com/naaccr/vol2_dd_export.git

Extracting

Windows / Mac OS / Linux

  1. Most new versions of Windows, Mac OS, and Linux come with archiving (zip/unzip) software built-in. When you double-click on the file, it will open in a new window in the archiving software (in Windows, this will look like a regular Explorer window).

  2. Windows 7: At the top of that window, click "Extract" and then "Extract All Files." Windows Vista: At the top of that window, click "Extract All Files." Windows 7/Vista: Choose the location to extract the files to and click Extract. Mac OS: The extraction will happen automatically in the same location as the original zip file.

  3. If a new window did not open containing the extracted files, navigate to the place where you extracted them. To continue, see the Usage page.

Usage

For more information about the tool and how to use it, see the Usage page.

If you have questions about the content or usage of this script, please contact info@naaccr.org.