Skip to content
GitLab
Commit 8e4891e6 authored by Alessia Vignolo's avatar Alessia Vignolo
Browse files

modified userguide

parent 8bfbe5e6
Expand all Hide whitespace changes
Inline Side-by-side
NanoShaper User Guide/UserGuide.aux
View file @ 8e4891e6
\relax
\providecommand\HyperFirstAtBeginDocument{\AtBeginDocument}
\HyperFirstAtBeginDocument{\ifx\hyper@anchor\@undefined
\global\let\oldcontentsline\contentsline
\gdef\contentsline#1#2#3#4{\oldcontentsline{#1}{#2}{#3}}
\global\let\oldnewlabel\newlabel
\gdef\newlabel#1#2{\newlabelxx{#1}#2}
\gdef\newlabelxx#1#2#3#4#5#6{\oldnewlabel{#1}{{#2}{#3}}}
\AtEndDocument{\ifx\hyper@anchor\@undefined
\let\contentsline\oldcontentsline
\let\newlabel\oldnewlabel
\fi}
\fi}
\global\let\hyper@last\relax
\gdef\HyperFirstAtBeginDocument#1{#1}
\providecommand\HyField@AuxAddToFields[1]{}
\citation{ray}
\citation{noi}
\citation{ray}
\citation{sanner}
\citation{Skin}
\citation{blobby}
\@writefile{toc}{\contentsline {section}{\numberline {1}What's new}{1}{section.1}}
\@MXV@newlabel{@MXV@annot1.page}{2}\@MXV@newlabel{@@MXV@annot1.page@}{2}
\@MXV@newlabel{@MXV@surf.u3d.draft}{false}\@MXV@newlabel{@@MXV@surf.u3d.draft@}{false}
\@MXV@newlabel{@MXV@surf.u3d.annotid}{1}\@MXV@newlabel{@@MXV@surf.u3d.annotid@}{1}
\@MXV@newlabel{@MXV@surf.u3d.externalviewer}{false}\@MXV@newlabel{@@MXV@surf.u3d.externalviewer@}{false}
\@MXV@newlabel{@MXV@surf.u3d.3D}{true}\@MXV@newlabel{@@MXV@surf.u3d.3D@}{true}
\@MXV@newlabel{@MXV@surf.u3d.3Dbg}{1.000000 1.000000 1.000000}\@MXV@newlabel{@@MXV@surf.u3d.3Dbg@}{1.000000 1.000000 1.000000}
\@MXV@newlabel{@MXV@surf.u3d.3Dlights}{White}\@MXV@newlabel{@@MXV@surf.u3d.3Dlights@}{White}
\@MXV@newlabel{@MXV@surf.u3d.3Drender}{ShadedIllustration}\@MXV@newlabel{@@MXV@surf.u3d.3Drender@}{ShadedIllustration}
\@MXV@newlabel{@MXV@surf.u3d.3Doncurpage}{1}\@MXV@newlabel{@@MXV@surf.u3d.3Doncurpage@}{1}
\@MXV@newlabel{@MXV@surf.u3d.annot}{90}\@MXV@newlabel{@@MXV@surf.u3d.annot@}{90}
\@writefile{lof}{\contentsline {figure}{\numberline {1}{\ignorespaces Example of Skin surface ray-traced by PovRay and triangulated (interactive)\relax }}{2}{figure.caption.1}}
\@writefile{toc}{\contentsline {section}{\numberline {2}Compilation/Installation}{3}{section.2}}
\@writefile{toc}{\contentsline {subsection}{\numberline {2.1}Automatic mode for Linux/Mac}{3}{subsection.2.1}}
\@writefile{toc}{\contentsline {subsection}{\numberline {2.2}Manual mode for any OS}{3}{subsection.2.2}}
\@writefile{toc}{\contentsline {section}{\numberline {3}Usage}{4}{section.3}}
\@writefile{toc}{\contentsline {subsection}{\numberline {3.1}Triangulation}{4}{subsection.3.1}}
\@writefile{toc}{\contentsline {subsection}{\numberline {3.2}Cavity Detection}{6}{subsection.3.2}}
\@writefile{toc}{\contentsline {subsection}{\numberline {3.3}Pocket detection}{7}{subsection.3.3}}
\@writefile{toc}{\contentsline {subsection}{\numberline {3.4}DelPhi interfacing}{7}{subsection.3.4}}
\newlabel{secDel}{{3.4}{7}{DelPhi interfacing\relax }{subsection.3.4}{}}
\@writefile{toc}{\contentsline {section}{\numberline {4}Python interfacing}{8}{section.4}}
\newlabel{secPy}{{4}{8}{Python interfacing\relax }{section.4}{}}
\@writefile{lol}{\contentsline {lstlisting}{\numberline {1}NanoShaper in Python}{8}{lstlisting.1}}
\@writefile{toc}{\contentsline {section}{\numberline {5}Configuration file keywords}{9}{section.5}}
\@writefile{toc}{\contentsline {subsection}{\numberline {5.1}Global parameters}{9}{subsection.5.1}}
\@writefile{toc}{\contentsline {subsection}{\numberline {5.2}Maps settings}{9}{subsection.5.2}}
\@writefile{toc}{\contentsline {subsection}{\numberline {5.3}Surface parameters}{10}{subsection.5.3}}
\@writefile{toc}{\contentsline {subsection}{\numberline {5.4}Mesh settings}{12}{subsection.5.4}}
\@writefile{toc}{\contentsline {subsection}{\numberline {5.5}Acceleration Grid Settings}{13}{subsection.5.5}}
\@writefile{toc}{\contentsline {subsection}{\numberline {5.6}File storage and others}{14}{subsection.5.6}}
\@writefile{toc}{\contentsline {section}{\numberline {6}Extending the framework}{15}{section.6}}
\bibdata{biblio}
\bibcite{blobby}{1}
\bibcite{noi}{2}
\@writefile{toc}{\contentsline {section}{\numberline {7}Examples}{16}{section.7}}
\bibcite{Skin}{3}
\bibcite{ray}{4}
\bibcite{sanner}{5}
\bibstyle{plain}
\relax
\providecommand\hyper@newdestlabel[2]{}
\providecommand\HyperFirstAtBeginDocument{\AtBeginDocument}
\HyperFirstAtBeginDocument{\ifx\hyper@anchor\@undefined
\global\let\oldcontentsline\contentsline
\gdef\contentsline#1#2#3#4{\oldcontentsline{#1}{#2}{#3}}
\global\let\oldnewlabel\newlabel
\gdef\newlabel#1#2{\newlabelxx{#1}#2}
\gdef\newlabelxx#1#2#3#4#5#6{\oldnewlabel{#1}{{#2}{#3}}}
\AtEndDocument{\ifx\hyper@anchor\@undefined
\let\contentsline\oldcontentsline
\let\newlabel\oldnewlabel
\fi}
\fi}
\global\let\hyper@last\relax
\gdef\HyperFirstAtBeginDocument#1{#1}
\providecommand\HyField@AuxAddToFields[1]{}
\providecommand\HyField@AuxAddToCoFields[2]{}
\citation{ray}
\citation{noi}
\citation{ray}
\citation{sanner}
\citation{Skin}
\citation{blobby}
\@writefile{toc}{\contentsline {section}{\numberline {1}What's new}{1}{section.1}}
\@MXV@newlabel{@MXV@annot1.page}{2}\@MXV@newlabel{@@MXV@annot1.page@}{2}
\@MXV@newlabel{@MXV@surf.u3d.draft}{false}\@MXV@newlabel{@@MXV@surf.u3d.draft@}{false}
\@MXV@newlabel{@MXV@surf.u3d.annotid}{1}\@MXV@newlabel{@@MXV@surf.u3d.annotid@}{1}
\@MXV@newlabel{@MXV@surf.u3d.externalviewer}{false}\@MXV@newlabel{@@MXV@surf.u3d.externalviewer@}{false}
\@MXV@newlabel{@MXV@surf.u3d.3D}{true}\@MXV@newlabel{@@MXV@surf.u3d.3D@}{true}
\@MXV@newlabel{@MXV@surf.u3d.3Dbg}{1.000000 1.000000 1.000000}\@MXV@newlabel{@@MXV@surf.u3d.3Dbg@}{1.000000 1.000000 1.000000}
\@MXV@newlabel{@MXV@surf.u3d.3Dlights}{White}\@MXV@newlabel{@@MXV@surf.u3d.3Dlights@}{White}
\@MXV@newlabel{@MXV@surf.u3d.3Drender}{ShadedIllustration}\@MXV@newlabel{@@MXV@surf.u3d.3Drender@}{ShadedIllustration}
\@MXV@newlabel{@MXV@surf.u3d.3Doncurpage}{1}\@MXV@newlabel{@@MXV@surf.u3d.3Doncurpage@}{1}
\@MXV@newlabel{@MXV@surf.u3d.annot}{91}\@MXV@newlabel{@@MXV@surf.u3d.annot@}{91}
\@writefile{lof}{\contentsline {figure}{\numberline {1}{\ignorespaces Example of Skin surface ray-traced by PovRay and triangulated (interactive)\relax }}{2}{figure.caption.1}}
\@writefile{toc}{\contentsline {section}{\numberline {2}Compilation/Installation}{3}{section.2}}
\@writefile{toc}{\contentsline {subsection}{\numberline {2.1}Automatic mode for Linux/Mac}{3}{subsection.2.1}}
\@writefile{toc}{\contentsline {subsection}{\numberline {2.2}Manual mode for any OS}{3}{subsection.2.2}}
\@writefile{toc}{\contentsline {section}{\numberline {3}Usage}{4}{section.3}}
\@writefile{toc}{\contentsline {subsection}{\numberline {3.1}Triangulation}{4}{subsection.3.1}}
\@writefile{toc}{\contentsline {subsection}{\numberline {3.2}Cavity Detection}{6}{subsection.3.2}}
\@writefile{toc}{\contentsline {subsection}{\numberline {3.3}Pocket detection}{6}{subsection.3.3}}
\@writefile{toc}{\contentsline {subsection}{\numberline {3.4}DelPhi interfacing}{7}{subsection.3.4}}
\newlabel{secDel}{{3.4}{7}{DelPhi interfacing}{subsection.3.4}{}}
\@writefile{toc}{\contentsline {section}{\numberline {4}Python interfacing}{8}{section.4}}
\newlabel{secPy}{{4}{8}{Python interfacing}{section.4}{}}
\@writefile{lol}{\contentsline {lstlisting}{\numberline {1}NanoShaper in Python}{8}{lstlisting.1}}
\@writefile{toc}{\contentsline {section}{\numberline {5}Configuration file keywords}{9}{section.5}}
\@writefile{toc}{\contentsline {subsection}{\numberline {5.1}Global parameters}{9}{subsection.5.1}}
\@writefile{toc}{\contentsline {subsection}{\numberline {5.2}Maps settings}{9}{subsection.5.2}}
\@writefile{toc}{\contentsline {subsection}{\numberline {5.3}Surface parameters}{10}{subsection.5.3}}
\@writefile{toc}{\contentsline {subsection}{\numberline {5.4}Mesh settings}{12}{subsection.5.4}}
\@writefile{toc}{\contentsline {subsection}{\numberline {5.5}Acceleration Grid Settings}{12}{subsection.5.5}}
\@writefile{toc}{\contentsline {subsection}{\numberline {5.6}File storage and others}{14}{subsection.5.6}}
\@writefile{toc}{\contentsline {section}{\numberline {6}Extending the framework}{15}{section.6}}
\bibdata{biblio}
\bibcite{blobby}{1}
\bibcite{noi}{2}
\bibcite{Skin}{3}
\@writefile{toc}{\contentsline {section}{\numberline {7}Examples}{16}{section.7}}
\bibcite{ray}{4}
\bibcite{sanner}{5}
\bibstyle{plain}
NanoShaper User Guide/UserGuide.log
View file @ 8e4891e6
This diff is collapsed.
NanoShaper User Guide/UserGuide.out
View file @ 8e4891e6
\BOOKMARK [1][-]{section.1}{What's new}{}% 1
\BOOKMARK [1][-]{section.2}{Compilation/Installation}{}% 2
\BOOKMARK [2][-]{subsection.2.1}{Automatic mode for Linux/Mac}{section.2}% 3
\BOOKMARK [2][-]{subsection.2.2}{Manual mode for any OS}{section.2}% 4
\BOOKMARK [1][-]{section.3}{Usage}{}% 5
\BOOKMARK [2][-]{subsection.3.1}{Triangulation}{section.3}% 6
\BOOKMARK [2][-]{subsection.3.2}{Cavity Detection}{section.3}% 7
\BOOKMARK [2][-]{subsection.3.3}{Pocket detection}{section.3}% 8
\BOOKMARK [2][-]{subsection.3.4}{DelPhi interfacing}{section.3}% 9
\BOOKMARK [1][-]{section.4}{Python interfacing}{}% 10
\BOOKMARK [1][-]{section.5}{Configuration file keywords}{}% 11
\BOOKMARK [2][-]{subsection.5.1}{Global parameters}{section.5}% 12
\BOOKMARK [2][-]{subsection.5.2}{Maps settings}{section.5}% 13
\BOOKMARK [2][-]{subsection.5.3}{Surface parameters}{section.5}% 14
\BOOKMARK [2][-]{subsection.5.4}{Mesh settings}{section.5}% 15
\BOOKMARK [2][-]{subsection.5.5}{Acceleration Grid Settings}{section.5}% 16
\BOOKMARK [2][-]{subsection.5.6}{File storage and others}{section.5}% 17
\BOOKMARK [1][-]{section.6}{Extending the framework}{}% 18
\BOOKMARK [1][-]{section.7}{Examples}{}% 19
\BOOKMARK [1][-]{section.1}{What's new}{}% 1
\BOOKMARK [1][-]{section.2}{Compilation/Installation}{}% 2
\BOOKMARK [2][-]{subsection.2.1}{Automatic mode for Linux/Mac}{section.2}% 3
\BOOKMARK [2][-]{subsection.2.2}{Manual mode for any OS}{section.2}% 4
\BOOKMARK [1][-]{section.3}{Usage}{}% 5
\BOOKMARK [2][-]{subsection.3.1}{Triangulation}{section.3}% 6
\BOOKMARK [2][-]{subsection.3.2}{Cavity Detection}{section.3}% 7
\BOOKMARK [2][-]{subsection.3.3}{Pocket detection}{section.3}% 8
\BOOKMARK [2][-]{subsection.3.4}{DelPhi interfacing}{section.3}% 9
\BOOKMARK [1][-]{section.4}{Python interfacing}{}% 10
\BOOKMARK [1][-]{section.5}{Configuration file keywords}{}% 11
\BOOKMARK [2][-]{subsection.5.1}{Global parameters}{section.5}% 12
\BOOKMARK [2][-]{subsection.5.2}{Maps settings}{section.5}% 13
\BOOKMARK [2][-]{subsection.5.3}{Surface parameters}{section.5}% 14
\BOOKMARK [2][-]{subsection.5.4}{Mesh settings}{section.5}% 15
\BOOKMARK [2][-]{subsection.5.5}{Acceleration Grid Settings}{section.5}% 16
\BOOKMARK [2][-]{subsection.5.6}{File storage and others}{section.5}% 17
\BOOKMARK [1][-]{section.6}{Extending the framework}{}% 18
\BOOKMARK [1][-]{section.7}{Examples}{}% 19
NanoShaper User Guide/UserGuide.tex
View file @ 8e4891e6
......@@ -114,7 +114,8 @@ In a Linux shell run:
\textsf{python setup.py}
\end{center}
%This will try to automatically guess your distribution, download and install the necessary packages accordingly,
This will list the packages needed to be installed manually, install a correct version of cmake, download CGAL, compile CGAL, patch CGAL, configure and compile NanoShaper as Stand Alone (.exe) or as a shared object for DelPhi.%, or as a Python module.
This will list the packages needed to be installed manually, install a correct version of cmake, download CGAL, patch CGAL, compile CGAL, configure and compile NanoShaper as Stand Alone (.exe) or as a shared object for DelPhi.
%, or as a Python module.
You will find NanoShaper in the build or build\_lib folder.
\subsection{Manual mode for any OS}
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

IIT