Add documentation for external users

[Sbozzolo]

If I am an external (ie, non Caltech) user, how do I obtain given artifacts? At the moment, the answer to this question is not immediately clear.

[waywardpidgeon]

I am attempting to expand the Aerosol artifact and have not been able to install the required package ClimaArtifactsHelper.jl. I get error messages saying it is not registered, and instantiate fails so need to know how to clone it directly from github. I have tied the obvious paths. I would appreciate some documentation, or the registration of this package.

Alternatively, since it is such a small package, could it not be included in the ClimaArtifacts package, or am I missing something here?

[Sbozzolo]

ClimaArtifacts helper is indeed in the ClimaArtifacts package, as found at the link.

The Manifest.toml files associated to each artifact should come with this package already. If not, you can dev it with ] dev ClimaArtifactsHelper.jl in the REPL in the main folder of this package.

Note, however that the creation of the artifact in itself with ClimaArtifactsHelper won't be particularly useful to you: if you run all the code before the create_artifact_guided, the script will produce a local artifact.

[waywardpidgeon]

I am still confused with this package. I overcame the problem with the 'helper', not with the suggestion which didn't work for me, but by cloning ClimaArtifacts not ClimaArtifacts.jl - the latter didn't work and I had attempted to then load the files by hand.
This worked for aerosol_concentrations leading to a successful instaniate and a status with
for the 'helper' having the line

[6ffa2572] ClimaArtifactsHelper v0.0.1 `..\ClimaArtifactsHelper.jl`

The creation of the artifact was also successful.

However, when I next tried earth_orography with eactly the same line in the respective Project.toml line for the 'helper', I was back to the same problem as before.

I am running the following:

Julia Version 1.10.5
Commit 6f3fdf7b36 (2024-08-27 14:19 UTC)
Build Info:
  Official https://julialang.org/ release
Platform Info:
  OS: Windows (x86_64-w64-mingw32)
  CPU: 16 × Intel(R) Core(TM) i7-10700 CPU @ 2.90GHz
  WORD_SIZE: 64
  LIBM: libopenlibm
  LLVM: libLLVM-15.0.7 (ORCJIT, skylake)
Threads: 1 default, 0 interactive, 1 GC (on 16 virtual cores)

[waywardpidgeon]

Here is some more info for my earth_orography attempts:

PS C:\Users\kevin\cc\ccex5\ClimaArtifacts\earth_orography> julia --project
_
_ _ ()_ | Documentation: https://docs.julialang.org
() | () () |
_ _ | | __ _ | Type "?" for help, "]?" for Pkg help.
| | | | | | |/ ` | |
| | || | | | (| | | Version 1.10.5 (2024-08-27)
/ |_'|||_'_| | Official https://julialang.org/ release
|__/ |

(earth_orography) pkg> instantiate
┌ Warning: could not download https://pkg.julialang.org/registries
│ exception = RequestError: HTTP/1.1 301 Australian region -> AU internal redirect trigger (Failed to connect to au.pkg.julialang.org port 443 after 2209 ms: Couldn't connect to server) while requesting https://pkg.julialang.org/registries
└ @ Pkg.Registry C:\Users\Kevin.DESKTOP-SVS3IFD.julia\juliaup\julia-1.10.5+0.x64.w64.mingw32\share\julia\stdlib\v1.10\Pkg\src\Registry\Registry.jl:69
Updating registry at C:\Users\Kevin.DESKTOP-SVS3IFD\.julia\registries\General
Updating git-repo https://github.com/JuliaRegistries/General.git
ERROR: expected package ClimaArtifactsHelper [6ffa2572] to be registered

[Sbozzolo]

ClimaArtifactsHelper is distributed with this repo. When you see ERROR: expected package ClimaArtifactsHelper [6ffa2572] to be registered, what you should do is add it to your environment.
Here's the steps:

• cd ClimaArtifacts
• cd earth_orography
• julia --project
  In the REPL, press ], this will move you to Pkg mode:
• dev ..
• instantiate
  With this, you should have a working environment.

[waywardpidgeon]

Thanks. I tried that and quite a few variants including using su mode. No success. Maybe its the Windows OS ?

PS C:\Users\kab\cc\ccex4\ClimaArtifacts\earth_orography> julia --project
               _
   _       _ _(_)_     |  Documentation: https://docs.julialang.org
  (_)     | (_) (_)    |
   _ _   _| |_  __ _   |  Type "?" for help, "]?" for Pkg help.
  | | | | | | |/ _` |  |
  | | |_| | | | (_| |  |  Version 1.10.5 (2024-08-27)
 _/ |\__'_|_|_|\__'_|  |  Official https://julialang.org/ release
|__/                   |

(earth_orography) pkg> dev ..
ERROR: could not find project file (Project.toml or JuliaProject.toml) in package at `..` maybe `subdir` needs to be specified

(earth_orography) pkg>

[Sbozzolo]

Oops, sorry! Indeed, it should have been dev ../ClimaArtifactsHelper.jl

[waywardpidgeon]

Good, that worked. Thanks.

One more question for someone new to this part of Julia:

To upload to data.caltech.edu (the Caltech Data Archive), please give me an example command, i.e. what is precisely meant by "the link"? Is it something like
c:\users\kevin\cc\ccex5\ClimaArtifacts\earth_orography\earth_orography_60arcsec_artifact?
Here is what I see on the screen:

Now, upload earth_orography_60arcsec_artifact.tar.gz to the Caltech Data Archive or Box, paste here the link, and press ENTER

Note that the given path is a subdirectory which contains a *.nc file, not a tarball.