CGNICO/Metahuman_DNA_Calibration
2
0
Fork 0
Code Issues 19 Pull Requests 1 Actions Packages Projects Releases 7 Wiki Activity

generate new documentation

Browse Source
This commit is contained in:
Srdjan Milicev 2022-12-22 11:59:03 +01:00
parent 67ed4ad552
commit 801a082494
19 changed files with 54 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README_out.md
View File

@ -37,10 +37,16 @@ To use these tools, you should be familiar with:
## External Software Dependencies
DNACalib's Python wrapper is compiled against Python 3.7. If you are using a different version of Python, you must recompile it. Any Python 3 version should be fine.
Pre-compiled binaries for Windows and Linux (both 64-bit) are part of the repository.
DNACalib's Python wrapper is compiled against Python 3.7. Pre-compiled binaries for Windows and Linux (both 64-bit) are part of the repository.
If you are using a different version of Python, you must recompile it. Any Python 3 version should be fine.
If a user has a different platform or architecture, the library and its dependencies must be compiled.
**Important**
DNA files are stored as [LFS (Large File Storage)](https://git-lfs.github.com/) files. They are downloaded with the rest of the code if
git-lfs is installed and configured to use. If you are not using git-lfs, you have to download DNA files manually.
Additional information can be found [here](faq_md#fix--runtimeerror--error-loading-dna--dna-signature-mismatched-expected-dna-got-ver-)
**Warning:**
Python 2 is not supported.

10
docs/README_out.md
View File

@ -37,10 +37,16 @@ To use these tools, you should be familiar with:
## External Software Dependencies
DNACalib's Python wrapper is compiled against Python 3.7. If you are using a different version of Python, you must recompile it. Any Python 3 version should be fine.
Pre-compiled binaries for Windows and Linux (both 64-bit) are part of the repository.
DNACalib's Python wrapper is compiled against Python 3.7. Pre-compiled binaries for Windows and Linux (both 64-bit) are part of the repository.
If you are using a different version of Python, you must recompile it. Any Python 3 version should be fine.
If a user has a different platform or architecture, the library and its dependencies must be compiled.
**Important**
DNA files are stored as [LFS (Large File Storage)](https://git-lfs.github.com/) files. They are downloaded with the rest of the code if
git-lfs is installed and configured to use. If you are not using git-lfs, you have to download DNA files manually.
Additional information can be found [here](faq_md#fix--runtimeerror--error-loading-dna--dna-signature-mismatched-expected-dna-got-ver-)
**Warning:**
Python 2 is not supported.

2
docs/dnacalib_md.html
View File

@ -206,7 +206,7 @@ If you are using a different architecture and/or platform, you must build DNACal
<li><p><a class="reference external" href="https://cmake.org/download/">CMake</a> at least version 3.14</p></li>
<li><p><a class="reference external" href="https://www.swig.org/download.html">SWIG</a> at least version 4.0.0</p></li>
<li><p><a class="reference external" href="https://www.python.org/downloads/">Python</a> To specify the exact version of python3 to use, set the CMake variable
<code class="docutils literal notranslate"><span class="pre">PYTHON3_EXACT_VERSION</span></code>. For example, to use the lib from Maya 2022, use minimum version 3.7.</p></li>
<code class="docutils literal notranslate"><span class="pre">PYTHON3_EXACT_VERSION</span></code>. For example, to use the lib from Maya 2022, use version 3.7.</p></li>
</ul>
<p>Use CMake to generate the build scripts required for building, e.g. by executing the following commands from the
<a class="reference external" href="https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/dnacalib"><code class="docutils literal notranslate"><span class="pre">dna_calibration/dnacalib/</span></code></a> directory:</p>

2
docs/dnacalib_out.md
View File

@ -88,7 +88,7 @@ Prerequisites:
- [CMake](https://cmake.org/download/) at least version 3.14
- [SWIG](https://www.swig.org/download.html) at least version 4.0.0
- [Python](https://www.python.org/downloads/) To specify the exact version of python3 to use, set the CMake variable
`PYTHON3_EXACT_VERSION`. For example, to use the lib from Maya 2022, use minimum version 3.7.
`PYTHON3_EXACT_VERSION`. For example, to use the lib from Maya 2022, use version 3.7.
Use CMake to generate the build scripts required for building, e.g. by executing the following commands from the
[`dna_calibration/dnacalib/`](https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/dnacalib) directory:

19
docs/faq_md.html
View File

@ -112,22 +112,9 @@
<h1>Frequently Asked Questions (FAQ)<a class="headerlink" href="#frequently-asked-questions-faq" title="Permalink to this headline"></a></h1>
<section id="fix-runtimeerror-error-loading-dna-dna-signature-mismatched-expected-dna-got-ver">
<h2>Fix “RuntimeError: Error loading DNA: DNA signature mismatched, expected DNA, got ver?”<a class="headerlink" href="#fix-runtimeerror-error-loading-dna-dna-signature-mismatched-expected-dna-got-ver" title="Permalink to this headline"></a></h2>
<p>DNA files are stored as <a class="reference external" href="https://git-lfs.github.com/">LFS</a> files (Here is <a class="reference external" href="https://www.atlassian.com/git/tutorials/git-lfs">another explanaintion</a> what LFS is).
This problem occurs when repo is downloaded as zip, and github then does not download LFS files as whole file, but as some metadata file.<br />
Open that Ada.dna file in some editor file, from location were MetaHuman DNA Calibration is downloaded and then in
<code class="docutils literal notranslate"><span class="pre">data/dna/Ada.dna</span></code> (eg <code class="docutils literal notranslate"><span class="pre">c:/MetaHuman-DNA-Calibration/data/dna/Ada.dna</span></code> you will got this:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">version</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">git</span><span class="o">-</span><span class="n">lfs</span><span class="o">.</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">spec</span><span class="o">/</span><span class="n">v1</span>
<span class="n">oid</span> <span class="n">sha256</span><span class="p">:</span><span class="n">e764cfab938283231bcb3e5af1c7bcbec5154bab4804aafa1b5b7dc6e400ca5e</span>
<span class="n">size</span> <span class="mi">73730354</span>
</pre></div>
</div>
<p>Which is not valid DNA file.</p>
<p>There is two ways to fix this issue:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">git</span> <span class="pre">clone</span> <span class="pre">https://github.com/EpicGames/MetaHuman-DNA-Calibration.git</span></code></p></li>
<li><p>manually download <span class="xref myst">Ada.dna</span> and/or <span class="xref myst">Taro.dna</span>, and put them in data directory
where you downloaded MetaHuman DNA Calibration. eg. <code class="docutils literal notranslate"><span class="pre">c:/MetaHuman-DNA-Calibration/data/dna</span></code></p></li>
</ul>
<p>In order to fix this issue, you should install <a class="reference external" href="https://git-lfs.github.com/">git-lfs</a>, and clone the repository again.
DNA files will be downloaded correctly then.
If you cannot install git-lfs, you can download DNA files manually.</p>
</section>
<section id="how-do-i-distribute-a-maya-scene">
<h2>How do I distribute a Maya scene?<a class="headerlink" href="#how-do-i-distribute-a-maya-scene" title="Permalink to this headline"></a></h2>

BIN
docs/faq_out.md (Stored with Git LFS)
View File

Binary file not shown.

8
docs/index.html
View File

@ -145,9 +145,13 @@ MetaHuman DNA Calibration tools are provided in a GitHub repository located at t
</section>
<section id="external-software-dependencies">
<h2>External Software Dependencies<a class="headerlink" href="#external-software-dependencies" title="Permalink to this headline"></a></h2>
<p>DNACalib’s Python wrapper is compiled against Python 3.7. If you are using a different version of Python, you must recompile it. Any Python 3 version should be fine.
Pre-compiled binaries for Windows and Linux (both 64-bit) are part of the repository.
<p>DNACalib’s Python wrapper is compiled against Python 3.7. Pre-compiled binaries for Windows and Linux (both 64-bit) are part of the repository.
If you are using a different version of Python, you must recompile it. Any Python 3 version should be fine.
If a user has a different platform or architecture, the library and its dependencies must be compiled.</p>
<p><strong>Important</strong>
DNA files are stored as <a class="reference external" href="https://git-lfs.github.com/">LFS (Large File Storage)</a> files. They are downloaded with the rest of the code if
git-lfs is installed and configured to use. If you are not using git-lfs, you have to download DNA files manually.</p>
<p>Additional information can be found <span class="xref myst">here</span></p>
<p><strong>Warning:</strong>
Python 2 is not supported.</p>
<p>DNACalib can be used in C++ projects as a C++ library.</p>

8
docs/index_.html
View File

@ -156,9 +156,13 @@ MetaHuman DNA Calibration tools are provided in a GitHub repository located at t
</section>
<section id="external-software-dependencies">
<h2>External Software Dependencies<a class="headerlink" href="#external-software-dependencies" title="Permalink to this headline"></a></h2>
<p>DNACalib’s Python wrapper is compiled against Python 3.7. If you are using a different version of Python, you must recompile it. Any Python 3 version should be fine.
Pre-compiled binaries for Windows and Linux (both 64-bit) are part of the repository.
<p>DNACalib’s Python wrapper is compiled against Python 3.7. Pre-compiled binaries for Windows and Linux (both 64-bit) are part of the repository.
If you are using a different version of Python, you must recompile it. Any Python 3 version should be fine.
If a user has a different platform or architecture, the library and its dependencies must be compiled.</p>
<p><strong>Important</strong>
DNA files are stored as <a class="reference external" href="https://git-lfs.github.com/">LFS (Large File Storage)</a> files. They are downloaded with the rest of the code if
git-lfs is installed and configured to use. If you are not using git-lfs, you have to download DNA files manually.</p>
<p>Additional information can be found <span class="xref myst">here</span></p>
<p><strong>Warning:</strong>
Python 2 is not supported.</p>
<p>DNACalib can be used in C++ projects as a C++ library.</p>

2
docs/searchindex.js
View File

File diff suppressed because one or more lines are too long

BIN
docs/sphinx/build/doctrees/dnacalib_md.doctree
View File

Binary file not shown.

BIN
docs/sphinx/build/doctrees/environment.pickle
View File

Binary file not shown.

BIN
docs/sphinx/build/doctrees/faq_md.doctree
View File

Binary file not shown.

BIN
docs/sphinx/build/doctrees/index.doctree
View File

Binary file not shown.

BIN
docs/sphinx/build/doctrees/index_.doctree
View File

Binary file not shown.

2
docs/sphinx/build/html/dnacalib_md.html
View File

@ -206,7 +206,7 @@ If you are using a different architecture and/or platform, you must build DNACal
<li><p><a class="reference external" href="https://cmake.org/download/">CMake</a> at least version 3.14</p></li>
<li><p><a class="reference external" href="https://www.swig.org/download.html">SWIG</a> at least version 4.0.0</p></li>
<li><p><a class="reference external" href="https://www.python.org/downloads/">Python</a> To specify the exact version of python3 to use, set the CMake variable
<code class="docutils literal notranslate"><span class="pre">PYTHON3_EXACT_VERSION</span></code>. For example, to use the lib from Maya 2022, use minimum version 3.7.</p></li>
<code class="docutils literal notranslate"><span class="pre">PYTHON3_EXACT_VERSION</span></code>. For example, to use the lib from Maya 2022, use version 3.7.</p></li>
</ul>
<p>Use CMake to generate the build scripts required for building, e.g. by executing the following commands from the
<a class="reference external" href="https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/dnacalib"><code class="docutils literal notranslate"><span class="pre">dna_calibration/dnacalib/</span></code></a> directory:</p>

19
docs/sphinx/build/html/faq_md.html
View File

@ -112,22 +112,9 @@
<h1>Frequently Asked Questions (FAQ)<a class="headerlink" href="#frequently-asked-questions-faq" title="Permalink to this headline"></a></h1>
<section id="fix-runtimeerror-error-loading-dna-dna-signature-mismatched-expected-dna-got-ver">
<h2>Fix “RuntimeError: Error loading DNA: DNA signature mismatched, expected DNA, got ver?”<a class="headerlink" href="#fix-runtimeerror-error-loading-dna-dna-signature-mismatched-expected-dna-got-ver" title="Permalink to this headline"></a></h2>
<p>DNA files are stored as <a class="reference external" href="https://git-lfs.github.com/">LFS</a> files (Here is <a class="reference external" href="https://www.atlassian.com/git/tutorials/git-lfs">another explanaintion</a> what LFS is).
This problem occurs when repo is downloaded as zip, and github then does not download LFS files as whole file, but as some metadata file.<br />
Open that Ada.dna file in some editor file, from location were MetaHuman DNA Calibration is downloaded and then in
<code class="docutils literal notranslate"><span class="pre">data/dna/Ada.dna</span></code> (eg <code class="docutils literal notranslate"><span class="pre">c:/MetaHuman-DNA-Calibration/data/dna/Ada.dna</span></code> you will got this:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">version</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">git</span><span class="o">-</span><span class="n">lfs</span><span class="o">.</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">spec</span><span class="o">/</span><span class="n">v1</span>
<span class="n">oid</span> <span class="n">sha256</span><span class="p">:</span><span class="n">e764cfab938283231bcb3e5af1c7bcbec5154bab4804aafa1b5b7dc6e400ca5e</span>
<span class="n">size</span> <span class="mi">73730354</span>
</pre></div>
</div>
<p>Which is not valid DNA file.</p>
<p>There is two ways to fix this issue:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">git</span> <span class="pre">clone</span> <span class="pre">https://github.com/EpicGames/MetaHuman-DNA-Calibration.git</span></code></p></li>
<li><p>manually download <span class="xref myst">Ada.dna</span> and/or <span class="xref myst">Taro.dna</span>, and put them in data directory
where you downloaded MetaHuman DNA Calibration. eg. <code class="docutils literal notranslate"><span class="pre">c:/MetaHuman-DNA-Calibration/data/dna</span></code></p></li>
</ul>
<p>In order to fix this issue, you should install <a class="reference external" href="https://git-lfs.github.com/">git-lfs</a>, and clone the repository again.
DNA files will be downloaded correctly then.
If you cannot install git-lfs, you can download DNA files manually.</p>
</section>
<section id="how-do-i-distribute-a-maya-scene">
<h2>How do I distribute a Maya scene?<a class="headerlink" href="#how-do-i-distribute-a-maya-scene" title="Permalink to this headline"></a></h2>

8
docs/sphinx/build/html/index.html
View File

@ -145,9 +145,13 @@ MetaHuman DNA Calibration tools are provided in a GitHub repository located at t
</section>
<section id="external-software-dependencies">
<h2>External Software Dependencies<a class="headerlink" href="#external-software-dependencies" title="Permalink to this headline"></a></h2>
<p>DNACalib’s Python wrapper is compiled against Python 3.7. If you are using a different version of Python, you must recompile it. Any Python 3 version should be fine.
Pre-compiled binaries for Windows and Linux (both 64-bit) are part of the repository.
<p>DNACalib’s Python wrapper is compiled against Python 3.7. Pre-compiled binaries for Windows and Linux (both 64-bit) are part of the repository.
If you are using a different version of Python, you must recompile it. Any Python 3 version should be fine.
If a user has a different platform or architecture, the library and its dependencies must be compiled.</p>
<p><strong>Important</strong>
DNA files are stored as <a class="reference external" href="https://git-lfs.github.com/">LFS (Large File Storage)</a> files. They are downloaded with the rest of the code if
git-lfs is installed and configured to use. If you are not using git-lfs, you have to download DNA files manually.</p>
<p>Additional information can be found <span class="xref myst">here</span></p>
<p><strong>Warning:</strong>
Python 2 is not supported.</p>
<p>DNACalib can be used in C++ projects as a C++ library.</p>

8
docs/sphinx/build/html/index_.html
View File

@ -156,9 +156,13 @@ MetaHuman DNA Calibration tools are provided in a GitHub repository located at t
</section>
<section id="external-software-dependencies">
<h2>External Software Dependencies<a class="headerlink" href="#external-software-dependencies" title="Permalink to this headline"></a></h2>
<p>DNACalib’s Python wrapper is compiled against Python 3.7. If you are using a different version of Python, you must recompile it. Any Python 3 version should be fine.
Pre-compiled binaries for Windows and Linux (both 64-bit) are part of the repository.
<p>DNACalib’s Python wrapper is compiled against Python 3.7. Pre-compiled binaries for Windows and Linux (both 64-bit) are part of the repository.
If you are using a different version of Python, you must recompile it. Any Python 3 version should be fine.
If a user has a different platform or architecture, the library and its dependencies must be compiled.</p>
<p><strong>Important</strong>
DNA files are stored as <a class="reference external" href="https://git-lfs.github.com/">LFS (Large File Storage)</a> files. They are downloaded with the rest of the code if
git-lfs is installed and configured to use. If you are not using git-lfs, you have to download DNA files manually.</p>
<p>Additional information can be found <span class="xref myst">here</span></p>
<p><strong>Warning:</strong>
Python 2 is not supported.</p>
<p>DNACalib can be used in C++ projects as a C++ library.</p>

2
docs/sphinx/build/html/searchindex.js
View File

File diff suppressed because one or more lines are too long