Skip to content

Commit 91a6855

Browse files
jeremymanningclaude
jeremymanning
and
claude
committed
Add comprehensive documentation and SSH setup guide
Created extensive documentation: 1. SSH Key Setup Guide (ssh_setup.rst): - Detailed SSH key generation and configuration - Cluster-specific setup for SLURM, PBS, SGE - Security best practices and troubleshooting - Multi-cluster management examples 2. Installation Guide (installation.rst): - Basic and development installation - Optional dependencies for Kubernetes - Verification instructions 3. SLURM Tutorial (tutorials/slurm_tutorial.rst): - Complete SLURM cluster integration guide - Resource specification and job management - Machine learning and scientific computing examples - Best practices and troubleshooting 4. Enhanced Sphinx Documentation: - Fixed Sphinx compilation (builds successfully) - Added SSH setup to main documentation index - Improved docstrings for critical functions Documentation now compiles cleanly and provides comprehensive guidance for users setting up and using Clustrix with clusters. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 0b42141 commit 91a6855

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+8063
-0
lines changed

‎docs/build/doctrees/api/config.doctree

109 KB
Binary file not shown.

‎docs/build/doctrees/api/decorator.doctree

23.1 KB
Binary file not shown.

‎docs/build/doctrees/api/local_executor.doctree

84.8 KB
Binary file not shown.

‎docs/build/doctrees/environment.pickle

6.43 MB
Binary file not shown.

‎docs/build/doctrees/index.doctree

20.2 KB
Binary file not shown.

‎docs/build/html/.buildinfo

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 548fec699a0e300d3ea089399767260a
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/build/html/_modules/clustrix/config.html

Lines changed: 241 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/build/html/_modules/clustrix/decorator.html

Lines changed: 469 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/build/html/_modules/clustrix/local_executor.html

Lines changed: 549 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/build/html/_modules/index.html

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
<!DOCTYPE html>
2+
3+
<html lang="en" data-content_root="../">
4+
<head>
5+
<meta charset="utf-8" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<title>Overview: module code &#8212; Clustrix Documentation</title>
8+
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" />
9+
<link rel="stylesheet" type="text/css" href="../_static/groundwork.css?v=fc6a0523" />
10+
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=554e4187" />
11+
<script src="../_static/documentation_options.js?v=01f34227"></script>
12+
<script src="../_static/doctools.js?v=9bcbadda"></script>
13+
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
14+
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
15+
<link rel="index" title="Index" href="../genindex.html" />
16+
<link rel="search" title="Search" href="../search.html" />
17+
</head><body>
18+
<div class="related" role="navigation" aria-label="Related">
19+
<h3>Navigation</h3>
20+
<ul>
21+
<li class="right" style="margin-right: 10px">
22+
<a href="../genindex.html" title="General Index"
23+
accesskey="I">index</a></li>
24+
<li class="right" >
25+
<a href="../py-modindex.html" title="Python Module Index"
26+
>modules</a> |</li>
27+
<li class="nav-item nav-item-0"><a href="../index.html">Clustrix</a> &#187;</li>
28+
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
29+
</ul>
30+
</div>
31+
32+
<div class="document">
33+
<div class="documentwrapper">
34+
<div class="bodywrapper">
35+
<div class="body" role="main">
36+
37+
<h1>All modules for which code is available</h1>
38+
<ul><li><a href="clustrix/config.html">clustrix.config</a></li>
39+
<li><a href="clustrix/decorator.html">clustrix.decorator</a></li>
40+
<li><a href="clustrix/local_executor.html">clustrix.local_executor</a></li>
41+
</ul>
42+
43+
<div class="clearer"></div>
44+
</div>
45+
</div>
46+
</div>
47+
<div class="sphinxsidebar" role="navigation" aria-label="Main">
48+
<div class="sphinxsidebarwrapper">
49+
<search id="searchbox" style="display: none" role="search">
50+
<h3 id="searchlabel">Quick search</h3>
51+
<div class="searchformwrapper">
52+
<form class="search" action="../search.html" method="get">
53+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
54+
<input type="submit" value="Go" />
55+
</form>
56+
</div>
57+
</search>
58+
<script>document.getElementById('searchbox').style.display = "block"</script>
59+
</div>
60+
</div>
61+
<div class="clearer"></div>
62+
</div>
63+
<div class="related" role="navigation" aria-label="Related">
64+
<h3>Navigation</h3>
65+
<ul>
66+
<li class="right" style="margin-right: 10px">
67+
<a href="../genindex.html" title="General Index"
68+
>index</a></li>
69+
<li class="right" >
70+
<a href="../py-modindex.html" title="Python Module Index"
71+
>modules</a> |</li>
72+
<li class="nav-item nav-item-0"><a href="../index.html">Clustrix</a> &#187;</li>
73+
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
74+
</ul>
75+
</div>
76+
<div class="footer" role="contentinfo">
77+
&#169; Copyright 2025, Contextual Dynamics Laboratory.
78+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
79+
</div>
80+
</body>
81+
</html>

0 commit comments

Comments
 (0)