@@ -718,17 +718,17 @@ <h2 id="methods">Methods</h2>
718718
719719
720720< h2 id ="cellengine.resources.population.Population " class ="doc doc-heading ">
721- < code > cellengine.resources.population.Population</ code >
721+ < code > cellengine.resources.population.Population</ code >
722722
723723
724724</ h2 >
725725
726726
727- < div class ="doc doc-contents first ">
727+ < div class ="doc doc-contents first ">
728+
728729
729730
730731
731-
732732
733733 < div class ="doc doc-children ">
734734
@@ -743,17 +743,17 @@ <h2 id="cellengine.resources.population.Population" class="doc doc-heading">
743743
744744
745745< h3 id ="cellengine.resources.population.Population.experiment_id " class ="doc doc-heading ">
746- < code class =" language-python "> < span class ="n "> experiment_id</ span > < span class ="p "> :</ span > < span class ="nb "> str</ span > </ code >
747-
746+ < code class =" language-python "> < span class ="n "> experiment_id</ span > < span class ="p "> :</ span > < span class ="nb "> str</ span > </ code >
747+
748748 < span class ="doc doc-labels ">
749749 < small class ="doc doc-label doc-label-property "> < code > property</ code > </ small >
750750 </ span >
751751
752752</ h3 >
753753
754754
755- < div class ="doc doc-contents ">
756- </ div >
755+ < div class ="doc doc-contents ">
756+ </ div >
757757
758758</ div >
759759
@@ -762,8 +762,8 @@ <h3 id="cellengine.resources.population.Population.experiment_id" class="doc doc
762762
763763
764764< h3 id ="cellengine.resources.population.Population.gates " class ="doc doc-heading ">
765- < code class =" language-python "> < span class ="n "> gates</ span > < span class ="p "> :</ span > < span class ="nb "> str</ span > </ code >
766-
765+ < code class =" language-python "> < span class ="n "> gates</ span > < span class ="p "> :</ span > < span class ="nb "> str</ span > </ code >
766+
767767 < span class ="doc doc-labels ">
768768 < small class ="doc doc-label doc-label-property "> < code > property</ code > </ small >
769769 < small class ="doc doc-label doc-label-writable "> < code > writable</ code > </ small >
@@ -772,8 +772,8 @@ <h3 id="cellengine.resources.population.Population.gates" class="doc doc-heading
772772</ h3 >
773773
774774
775- < div class ="doc doc-contents ">
776- </ div >
775+ < div class ="doc doc-contents ">
776+ </ div >
777777
778778</ div >
779779
@@ -782,19 +782,19 @@ <h3 id="cellengine.resources.population.Population.gates" class="doc doc-heading
782782
783783
784784< h3 id ="cellengine.resources.population.Population.id " class ="doc doc-heading ">
785- < code class =" language-python "> < span class ="nb "> id</ span > < span class ="p "> :</ span > < span class ="nb "> str</ span > </ code >
786-
785+ < code class =" language-python "> < span class ="nb "> id</ span > < span class ="p "> :</ span > < span class ="nb "> str</ span > </ code >
786+
787787 < span class ="doc doc-labels ">
788788 < small class ="doc doc-label doc-label-property "> < code > property</ code > </ small >
789789 </ span >
790790
791791</ h3 >
792792
793793
794- < div class ="doc doc-contents ">
795-
794+ < div class ="doc doc-contents ">
795+
796796 < p > Alias for < code > _id</ code > .</ p >
797- </ div >
797+ </ div >
798798
799799</ div >
800800
@@ -803,8 +803,8 @@ <h3 id="cellengine.resources.population.Population.id" class="doc doc-heading">
803803
804804
805805< h3 id ="cellengine.resources.population.Population.name " class ="doc doc-heading ">
806- < code class =" language-python "> < span class ="n "> name</ span > < span class ="p "> :</ span > < span class ="nb "> str</ span > </ code >
807-
806+ < code class =" language-python "> < span class ="n "> name</ span > < span class ="p "> :</ span > < span class ="nb "> str</ span > </ code >
807+
808808 < span class ="doc doc-labels ">
809809 < small class ="doc doc-label doc-label-property "> < code > property</ code > </ small >
810810 < small class ="doc doc-label doc-label-writable "> < code > writable</ code > </ small >
@@ -813,8 +813,8 @@ <h3 id="cellengine.resources.population.Population.name" class="doc doc-heading"
813813</ h3 >
814814
815815
816- < div class ="doc doc-contents ">
817- </ div >
816+ < div class ="doc doc-contents ">
817+ </ div >
818818
819819</ div >
820820
@@ -823,8 +823,8 @@ <h3 id="cellengine.resources.population.Population.name" class="doc doc-heading"
823823
824824
825825< h3 id ="cellengine.resources.population.Population.parent_id " class ="doc doc-heading ">
826- < code class =" language-python "> < span class ="n "> parent_id</ span > < span class ="p "> :</ span > < span class ="n "> Union</ span > < span class ="p "> [</ span > < span class ="nb "> str</ span > < span class ="p "> ,</ span > < span class ="kc "> None</ span > < span class ="p "> ]</ span > </ code >
827-
826+ < code class =" language-python "> < span class ="n "> parent_id</ span > < span class ="p "> :</ span > < span class ="n "> Union</ span > < span class ="p "> [</ span > < span class ="nb "> str</ span > < span class ="p "> ,</ span > < span class ="kc "> None</ span > < span class ="p "> ]</ span > </ code >
827+
828828 < span class ="doc doc-labels ">
829829 < small class ="doc doc-label doc-label-property "> < code > property</ code > </ small >
830830 < small class ="doc doc-label doc-label-writable "> < code > writable</ code > </ small >
@@ -833,8 +833,8 @@ <h3 id="cellengine.resources.population.Population.parent_id" class="doc doc-hea
833833</ h3 >
834834
835835
836- < div class ="doc doc-contents ">
837- </ div >
836+ < div class ="doc doc-contents ">
837+ </ div >
838838
839839</ div >
840840
@@ -843,8 +843,8 @@ <h3 id="cellengine.resources.population.Population.parent_id" class="doc doc-hea
843843
844844
845845< h3 id ="cellengine.resources.population.Population.terminal_gate_gid " class ="doc doc-heading ">
846- < code class =" language-python "> < span class ="n "> terminal_gate_gid</ span > < span class ="p "> :</ span > < span class ="n "> Union</ span > < span class ="p "> [</ span > < span class ="nb "> str</ span > < span class ="p "> ,</ span > < span class ="kc "> None</ span > < span class ="p "> ]</ span > </ code >
847-
846+ < code class =" language-python "> < span class ="n "> terminal_gate_gid</ span > < span class ="p "> :</ span > < span class ="n "> Union</ span > < span class ="p "> [</ span > < span class ="nb "> str</ span > < span class ="p "> ,</ span > < span class ="kc "> None</ span > < span class ="p "> ]</ span > </ code >
847+
848848 < span class ="doc doc-labels ">
849849 < small class ="doc doc-label doc-label-property "> < code > property</ code > </ small >
850850 < small class ="doc doc-label doc-label-writable "> < code > writable</ code > </ small >
@@ -853,8 +853,8 @@ <h3 id="cellengine.resources.population.Population.terminal_gate_gid" class="doc
853853</ h3 >
854854
855855
856- < div class ="doc doc-contents ">
857- </ div >
856+ < div class ="doc doc-contents ">
857+ </ div >
858858
859859</ div >
860860
@@ -863,151 +863,143 @@ <h3 id="cellengine.resources.population.Population.terminal_gate_gid" class="doc
863863
864864
865865< h3 id ="cellengine.resources.population.Population.unique_name " class ="doc doc-heading ">
866- < code class =" language-python "> < span class ="n "> unique_name</ span > < span class ="p "> :</ span > < span class ="nb "> str</ span > </ code >
867-
866+ < code class =" language-python "> < span class ="n "> unique_name</ span > < span class ="p "> :</ span > < span class ="nb "> str</ span > </ code >
867+
868868 < span class ="doc doc-labels ">
869869 < small class ="doc doc-label doc-label-property "> < code > property</ code > </ small >
870870 </ span >
871871
872872</ h3 >
873873
874874
875- < div class ="doc doc-contents ">
876-
875+ < div class ="doc doc-contents ">
876+
877877 < p > The unique name for this population (has ancestor names prepended and
878878numerical suffixes appended until the name is unique).</ p >
879879< p > This value is calculated by CellEngine; if the population is renamed,
880880this value will not be correct until < code > pop.update()</ code > is called.</ p >
881- </ div >
881+ </ div >
882882
883883</ div >
884884
885885
886886
887-
888887< div class ="doc doc-object doc-function ">
889888
890889
891-
892890< h3 id ="cellengine.resources.population.Population.delete " class ="doc doc-heading ">
893- < code class =" language-python "> < span class ="n "> delete</ span > < span class ="p "> ()</ span > </ code >
891+ < code class =" language-python "> < span class ="n "> delete</ span > < span class ="p "> ()</ span > </ code >
894892
895893</ h3 >
896894
897895
898- < div class ="doc doc-contents ">
896+ < div class ="doc doc-contents ">
899897
900- </ div >
898+ </ div >
901899
902900</ div >
903901
904-
905902< div class ="doc doc-object doc-function ">
906903
907904
908-
909905< h3 id ="cellengine.resources.population.Population.get " class ="doc doc-heading ">
910- < code class =" language-python "> < span class ="n "> get</ span > < span class ="p "> (</ span > < span class ="n "> experiment_id</ span > < span class ="p "> ,</ span > < span class ="n "> _id</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span > < span class ="n "> name</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> )</ span > </ code >
911-
906+ < code class =" language-python "> < span class ="n "> get</ span > < span class ="p "> (</ span > < span class ="n "> experiment_id</ span > < span class ="p "> ,</ span > < span class ="n "> _id</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span > < span class ="n "> name</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> )</ span > </ code >
907+
912908 < span class ="doc doc-labels ">
913909 < small class ="doc doc-label doc-label-classmethod "> < code > classmethod</ code > </ small >
914910 </ span >
915911
916912</ h3 >
917913
918914
919- < div class ="doc doc-contents ">
920-
915+ < div class ="doc doc-contents ">
916+
921917 < p > Get Population by name or ID for a specific experiment. Either
922918< code > name</ code > or < code > _id</ code > must be specified.</ p >
923919
924920
925-
926- < p > < span class ="doc-section-title "> Parameters:</ span > </ p >
927- < table >
928- < thead >
929- < tr >
930- < th > Name</ th >
931- < th > Type</ th >
932- < th > Description</ th >
933- < th > Default</ th >
934- </ tr >
935- </ thead >
936- < tbody >
937- < tr class ="doc-section-item ">
938- < td > < code > experiment_id</ code > </ td >
939- < td >
940- < code > str</ code >
941- </ td >
942- < td >
943- < div class ="doc-md-description ">
944- < p > ID of the experiment this attachment is connected with.</ p >
945- </ div >
946- </ td >
947- < td >
948- < em > required</ em >
949- </ td >
950- </ tr >
951- < tr class ="doc-section-item ">
952- < td > < code > _id</ code > </ td >
953- < td >
954- < code > optional</ code >
955- </ td >
956- < td >
957- < div class ="doc-md-description ">
958- < p > ID of the attachment.</ p >
959- </ div >
960- </ td >
961- < td >
962- < code > None</ code >
963- </ td >
921+ < p > < span class ="doc-section-title "> Parameters:</ span > </ p >
922+ < table >
923+ < thead >
924+ < tr >
925+ < th > Name</ th >
926+ < th > Type</ th >
927+ < th > Description</ th >
928+ < th > Default</ th >
964929 </ tr >
965- < tr class ="doc-section-item ">
966- < td > < code > name</ code > </ td >
967- < td >
968- < code > optional</ code >
969- </ td >
970- < td >
971- < div class ="doc-md-description ">
972- < p > Name of the experiment.</ p >
973- </ div >
974- </ td >
975- < td >
976- < code > None</ code >
977- </ td >
978- </ tr >
979- </ tbody >
980- </ table >
930+ </ thead >
931+ < tbody >
932+ < tr class ="doc-section-item ">
933+ < td > < code > experiment_id</ code > </ td >
934+ < td >
935+ < code > str</ code >
936+ </ td >
937+ < td >
938+ < div class ="doc-md-description ">
939+ < p > ID of the experiment this attachment is connected with.</ p >
940+ </ div >
941+ </ td >
942+ < td >
943+ < em > required</ em >
944+ </ td >
945+ </ tr >
946+ < tr class ="doc-section-item ">
947+ < td > < code > _id</ code > </ td >
948+ < td >
949+ < code > optional</ code >
950+ </ td >
951+ < td >
952+ < div class ="doc-md-description ">
953+ < p > ID of the attachment.</ p >
954+ </ div >
955+ </ td >
956+ < td >
957+ < code > None</ code >
958+ </ td >
959+ </ tr >
960+ < tr class ="doc-section-item ">
961+ < td > < code > name</ code > </ td >
962+ < td >
963+ < code > optional</ code >
964+ </ td >
965+ < td >
966+ < div class ="doc-md-description ">
967+ < p > Name of the experiment.</ p >
968+ </ div >
969+ </ td >
970+ < td >
971+ < code > None</ code >
972+ </ td >
973+ </ tr >
974+ </ tbody >
975+ </ table >
981976
982- </ div >
977+ </ div >
983978
984979</ div >
985980
986-
987981< div class ="doc doc-object doc-function ">
988982
989983
990-
991984< h3 id ="cellengine.resources.population.Population.update " class ="doc doc-heading ">
992- < code class =" language-python "> < span class ="n "> update</ span > < span class ="p "> ()</ span > </ code >
985+ < code class =" language-python "> < span class ="n "> update</ span > < span class ="p "> ()</ span > </ code >
993986
994987</ h3 >
995988
996989
997- < div class ="doc doc-contents ">
998-
990+ < div class ="doc doc-contents ">
991+
999992 < p > Save changes to this Population to CellEngine.</ p >
1000993
1001- </ div >
994+ </ div >
1002995
1003996</ div >
1004997
1005998
1006999
10071000 </ div >
10081001
1009- </ div >
1010-
1002+ </ div >
10111003
10121004</ div >
10131005
0 commit comments