Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Naming Examples

Poor project titles:

  • Plankton data

  • ROV data from SueData Management

  • Workshop for Mike

Better project titles:

  • Plankton Diversity Data , Prince William Sound, 2012-2016Management Workshop, University of Wyoming ARCC, Fall 2024

  • Conductivity, temperature and depth data for 12 northwestern Gulf of Mexico locations, May to July 2012

  • SAFARI 2000 Upper Water Column Profiles, Gulf of Alaska, 2011-2012

...

Project Naming on ARCC Systems

While the project names above are very descriptive and something to record in a README file, ARCC systems have restrictions on how the type of characters and how many can be used in a project name. This is due to how permissions work on the system and very long project names with spaces or other special characters can cause problems with the administration of the system.

The recommended limitation for project names on ARCC are to use acronyms when possible or shorten words in a logical way. The restrictions are as follows:

  • Lowercase letters and numbers only

  • Hyphens are allowed, but no other special characters such as underscores

  • No longer than sixteen (16) characters

For Example, if this tutorial were to be a project on ARCC systems, we would take the long title of “Data Management Workshop, University of Wyoming ARCC, Fall 2024” and change it to read as one of these suggestions:

  • data-mgmt-arcc24

  • arcc-datmgt-uw24

...

Organizing Folders within a Project

...

  • Organize folders by major project components.

  • Create a hierarchical system with nested subfolders (high-level folders for broad topics with more specific folders within). Examples of high-level folder topics include:

    • Images

    • Data files

    • Project admin documents

    • PDFs of related literatureInput data files by discreet location/source/type

    • Metadata

    • Code or scripts

    • Results or output data

  • Organize the data by data type and then by research activity.

  • Separate preliminary and final data into different folder structures.

  • Be consistent with your folder organization throughout the life of your project and/or Research Campaign.

...

Folder Organization Example

...

Info

On ARCC systems, folder/directory names do not have to comply with the project name restrictions, but it helpful to keep them as short as possible while being descriptive, without using too many special characters and no spaces.

...

Level of Granularity

It may be unrealistic to anticipate and pre-create every folder that will be needed for a project. Instead, consider the level of folder hierarchy that will provide sufficient structure for users and collaborators on your project to create their own subfolders.

...