Arches-HIP Documentation

73 Pages·2016·2.71 MB·English

Arches-HIP Documentation
Release 1.0
Farallon Geographics, Inc.
Aug 10, 2017

Contents
1 Overview 3
1.1 WhatisArches-HIP? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.2 WhoisArches-HIPfor? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2 GettingStarted 5
2.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2 SystemRequirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.3 Dependencies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.4 InstallatingArches-HIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.5 Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.6 RunningArches-HIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.7 Beforeyougolive... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3 Arches-HIPDataResources 13
3.1 HIPGraphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
3.2 IncludedAuthorityFiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
4 LoadingData 21
4.1 BeforeYouStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
4.2 PreparingArches: CreatingandLoadingControlledVocabularies . . . . . . . . . . . . . . . . . . . 22
4.3 ImportingCulturalHeritageDataintoArches-HIP . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
4.4 Loada.ARCHESorShapefileintoArches-HIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
4.5 UnloadingCulturalHeritageData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
4.6 OptionalGISLayersforAdministrativeAreas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
5 UsingArches-HIP 37
6 SystemAdministration 39
6.1 AdministrationApp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
6.2 ReferenceDataManager(RDM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
6.3 ExportingData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
7 SettingsandCustomization 45
7.1 HomePageandBranding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
7.2 HIPTitleBlock. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
7.3 SavedSearches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
7.4 AdditionalContent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
i
7.5 GoogleAnalytics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
7.6 MapSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
7.7 Basemaps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
7.8 Overlays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
7.9 ResourceMapMarkers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
7.10 Geocoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
7.11 Localization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
8 Extra 55
8.1 ProductionConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
8.2 Convertingto.arches/.relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
9 AppendixA 67
9.1 Activity.E7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
9.2 Actor.E39 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
9.3 HeritageResource.E18 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
9.4 HeritageResourceGroup.E27 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
9.5 HistoricalEvent.E5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
9.6 InformationResource.E73 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
ii
Arches-HIPDocumentation,Release1.0
Contents:
Contents 1
Arches-HIPDocumentation,Release1.0
2 Contents
1
CHAPTER
Overview
What is Arches-HIP?
Arches-HIP (Heritage Inventory Package) is a web application designed to make it easy to create and maintain an
inventoryofculturalheritageresourcesatalocal,regional,ornationalscale.
Arches-HIP supports several cultural heritage data types; these data types are called “Resources”. Resources allow
youtocreatedatarecordsanddescribeimportant,culturallysignficantobjects,activities,events,andpeople.
Arches-HIPsupportsthefollowingresourcetypes:
• Heritage Resources: These are culturally significant objects such as buildings and monuments. However,
HeritageResourcesmayincludeanyobjectthatanorganizationregardsasimportant. Examplesincludeairraid
sirens,statues,canals,roads,gates,bridges,etc.
• Heritage Resource Groups These are collections of heritage resources that are best regarded as a group. In
Europe,suchresourcesareoftenreferredtoasensembles. IntheUnitedStates,districtsorlandscapesmaybe
inventoriedasHeritageResourceGroups.
• Activity In Arches-HIP, activities are resources that occur over a period of time. Examples include surveys,
investigations,excavations,literaturereview,andotheractions.
• HistoricEventTheseareculturallysignificantoccurrences. Examplesincludethe1906SanFranciscoEarth-
quake,CoronationofNapoleon,andtheNormandyBeachlandingsinWWII.
• ActorInArches-HIP,actorresourcesarepersons,groupsofpeople,ororganizations.
• InformationObjectsTheseareobjectsthatencodeinformationsuchasanimage(eitherdigitaloratraditional
photograph),documents,signs,inscriptions,or331/3rpmrecords.
AkeydesignconsiderationfortheArches-HIPwebapplicationistoallowyoutoquicklycreateandeasilymanage
culturalheritagedata. Toachievethisgoal,Arches-HIPallowsyoutocreaterelationshipsbetweenresourcetypesto
morepreciselydescribethesignificanceofculturalheritageobjects. Forexample,inArches-HIPyoucan:
• CreateanActorResource,suchas“FrankLloydWright”
• CreateaHeritageResource,suchas“HollyhockHouse”
3
Arches-HIPDocumentation,Release1.0
• Linktheresourcesinawaythatdescribestheirrelationship: “FrankLloydWright”“architected”“Hollyhock
House”
Arches-HIP’s ability to track relationships between resources is a key capability that can support a richer cultural
heritageinventoryandmoreintuitivediscoveryofheritagerecords.
Arches-HIP uses the Reference Data Manager (RDM), a thesaurus management model included in the Arches web
framework,toletyoumanagethetermsthatyouwillneedtodescribeheritageresourcesandtherelationshipsbetween
resources(e.g.: “architected”).
VersionHistory
v1.0April,2015: InitialRelease
License
Arches-HIPisfreesoftwareandislicensedunderthetermsoftheGNUAfferoGeneralPublicLicense
(http://www.gnu.org/licenses/agpl-3.0.html)
Who is Arches-HIP for?
Arches-HIPisprimarilyintendedfororganizationsthatareresponsibleforcreatingculturalheritageinventoriesasan
essentialstepinthepreservationandconservationofheritage.
4 Chapter1. Overview
2
CHAPTER
Getting Started
Introduction
WelcometotheArchesHIPInstallationGuide. ThisdocumentisintendedtohelpyouquicklygetHIPrunningon
yourserver.
What do I need to know to use this guide?
ArchesHIPisdesignedtoletyoumanagemanytypesofculturalheritagedata. Andwhilewe’vetriedtomakeiteasy
toinstallHIP,you’llneedtomakesomedecisionsonhowyouwishtodescribeandmanagetheinformationthatgoes
intoArchesHIP.Butdon’tworry, we’vealsoincludedlotsofexamplesandwell-thought-outdefaultsforsettingup
thesoftware.
So, installing HIP means loading software and deciding how you want to describe the cultural heritage information
that’s important to you. We’ve written this guide assuming that you are comfortable working with your computer’s
commandline,andthatyoucanedittextfileswithease.
Arches HIP is built on the open source Arches framework. The Arches documentation can be found here: http:
//arches3.readthedocs.org/en/latest/ThisdocumentmaybeusefulforunderstandingArches-HIPandwillbereferenced
throughouttheArchesHIPdocumentation.
That’sit! Feelfreetotapacolleagueontheshoulderifyouneedalittlehelpalongtheway,orcheckouttheresources
athttp://www.archesproject.orgformoresupport.
System Requirements
ThereareafewthingstoknowaboutArchesHIPbeforewegetstarted.
PleasenotethatHIPhasbeendevelopedformodernbrowsers. Itsupports:
• Firefox
• Chrome
5
Arches-HIPDocumentation,Release1.0
• Safari
• Opera
• InternetExplorer10orhigher.
Minimumsystemrequirements:
• Atleast4GBofRAMforevaluationandtesting,or8to16GBforproduction.
• 10GBminimumtoinstallthecodebaseandtestdataset,butdiskspacerequirementswillvarygreatlydepending
onthesizeofyourdataset
It’simportanttorecognizethatArchesHIPisdesignedtomanagelarge,enterprise-scaleCulturalHeritageinventories.
Thesoftwareissophisticatedandisdesignedtobesupportextensivecustomization. Thismeansthattherearemany
waystodeployArchesHIP.
We’vewrittenthisguidetostreamlinetheinstallationofArchesServerandtheinthemorestraight-forwardmanner
possible. Theseinstallationinstructionsprovidestep-by-stepguidelinesforinstallingArchesHIP.
Dependencies
Archesrequiresthefollowingapplications/libraries:
• PostgreSQLrelationaldatabase(version9.3)(http://www.postgresql.org/download/)
• PostGIS(version2.x)spatialmoduleforPostgreSQL(http://postgis.net/install)
• Python (version 2.7.6 - there seem to be issues with later versions of python) (https://www.python.org/
downloads/)
• GEOS(http://trac.osgeo.org/geos/)
You’llneedtoinstalleachofthesecomponentsonyourcomputerbeforeyoucaninstallArches.Luckily,eachofthese
technologiesprovidecomprehensiveinstallationinstructions.
NoteFortheinstallationprocessyouwillneedpipinstalledonyoursystem. Ifyoudon’talreadyhaveit,youcanfind
instructionstoinstallithere: https://pip.pypa.io/en/latest/installing.html
Installating Arches-HIP
TheseinstallationinstructionswillguideyouthroughtheinstallationandconfigurationproceessfortheArches-HIP
application. Whenwe’redone,you’llhavethefollowingfoldersonyoursystem:
/Projects
/ENV
/my_hip_app
The/ENVfolderiswheretheArchesframeworkandtheArches-HIPapplicationswillbeinstalled
The/my_hip_appfolderisafolderthatwillholdyourcustomsettingsfortheHIP.
CustomsettingsincludesuchthingsasthetextandlogosontheHIPhomepage,yourmapsettings,andotherinfor-
mationneededtoensurethattheHIPmeetsyourspecificrequirements.
WithyourArchesdependenciesinstalled,youarenowreadytoinstallHIP.
#1. CreateanArchesfolder:
Createafoldercalled‘Projects’(oranyothernamethatyouprefer)onyourcomputer.
6 Chapter2. GettingStarted