Polaris

User's guide

  • Quick Start for Users
  • Tasks
  • Config Files
  • Suites
  • Ocean component
  • Sea ice component
  • Machines

Developer's guide

  • Quick Start for Developers
  • Overview
  • Command-line interface
  • Organization of Tasks
  • Ocean component
  • SeaIce component
  • Framework
  • Machines
  • Troubleshooting
  • Documentation
  • Building the Documentation
  • Deploying a new spack environment
  • API reference
    • Components
    • polaris framework
      • Command-line interface
      • Base Classes
      • components
      • config
      • io
        • polaris.io.download
        • polaris.io.symlink
        • polaris.io.update_permissions
      • job
      • logging
      • mesh
      • model_step
      • mpas
      • namelist
      • parallel
      • provenance
      • remap
      • streams
      • validate
      • viz
      • yaml
  • Design Documents

Tutorials

  • Developer Tutorial: Adding a new test group

Glossary

  • Glossary
Polaris
  • API reference
  • polaris.io.symlink
  • View page source

polaris.io.symlink

polaris.io.symlink(target, link_name, overwrite=True)[source]

From https://stackoverflow.com/a/55742015/7728169 Create a symbolic link named link_name pointing to target. If link_name exists then FileExistsError is raised, unless overwrite=True. When trying to overwrite a directory, IsADirectoryError is raised.

Parameters:
  • target (str) – The file path to link to

  • link_name (str) – The name of the new link

  • overwrite (bool, optional) – Whether to replace an existing link if one already exists

Previous Next

© Copyright 2025, Energy Exascale Earth System Model Project.

Built with Sphinx using a theme provided by Read the Docs.
Other Versions v: 0.5.0
Tags
0.5.0
Branches
main