bag-it-fits-it

An archiving and metadata-scraping tool

---

(TODO: separate entire instructions into mac and windows)

Table of Contents

• Prerequisites
  • Python
    • Installing Python (Windows)
    • Installing Python (MacOS)
  • Java
    • Installing Java (Windows) (TODO)
    • Installing Java (MacOS) (TODO)
  • FITS (TODO?)
• Setup
• How to Use

---

Installing Python (Windows)

First check if Python is already set up on your computer by running "python -V" in your Command Prompt.

C:\Users\Me>python -V
Python 3.6.1

C:\Users\Me>

If this command does not print a python version:

1. Navigate to http://python.org/downloads and download the latest Python 3.x.x release (not 2.7.x)
2. Run the install file, check the "Add Python 3.6 to PATH" box, and complete installation process
3. open a Command Prompt and

---

Installing Python (MacOS)

Python should come pre-installed on MacOS. To double check, run "python -V" in a terminal:

$ python -V
Python x.x.x
$

---

Setup

1. Git clone or download/unzip bag-it-fits-it directory to desired location
2. Download/unzip the latest release of FITS
3. rename the fits directory from fits-x.x.x (where x.x.x is the most recent version) to fits
4. move the fits directory into the bag-it-fits-it directory (i.e. path/to/bag-it-fits-it/fits/)

---

How to Use

1. Open a Command Prompt window (Windows) or Terminal window (MacOS)
   • Windows: Start Menu -> Accessories -> Command Prompt (or "Search programs and files" for "Command Prompt")
   • MacOS: Applications -> Utilities -> Terminal
2. Navigate to the bag-it-fits-it directory in the terminal/Command Prompt

~ $ cd path/to/bag-it-fits-it
~/path/to/bag-it-fits-it $

2. Run bag-it-fits-it.py using two additional arguments
   • the directory to bag 'n fits
   • the location to place the report and bags

~/path/to/bag-it-fits-it $ bag-it-fits-it.py path/to/bag path/to/output

Examples

Windows

1. Run bag-it-fits-it.py, located at C:\Users\Me\Desktop\bag-it-fits-it-master\ on a folder located at C:\Users\Me\Desktop\vacay_pics\ and want to place the bags and reports at C:\Users\Me\Desktop\photo_album_reports:

C:\Users\Me\Desktop\bag-it-fits-it-master>bag-it-fits-it.py "C:\Users\Me\Desktop\vacay_pics\"
"C:\Users\Me\Desktop\photo_album_reports"

(all one line)

MacOS

(TODO)

Pitfalls

• Avoid using an output path that contains spaces.
• Windows: Surround both paths in quotes.
• When extracting fits-x.x.x.zip, it may create two nested folders. Make sure script_dir/fits contains fits.bat or fits.sh, and isn't located in another folder, e.g. fits/fits-1.1.1/fits.sh